firemore.core — org.clojars.samedhi/firemore 0.3.4

Liking cljdoc? Tell your friends :D

ClojureScript only.

add!
clj->fire
delete!
delete-user!
fire->clj
get
login-anonymously!
logout!
merge!
push!
subtract!
supported-types
throw-if-unsupported
uid
unwatch-user
user
user-atom
user-chan
watch
watch-user
write!

firemore.core

add!^cljs

(add! atm path reference)

Sync the current value of reference at path within the atm

atm - A clojure atom. path - a vector location within the atm where the Firestore reference will be written. reference - a reference to a location in Firestore.

Note that the the {path reference} will show up under the :firemore key, and the {path reference-value} will show up under the :firemore key in atm.

Sync the current value of `reference` at `path` within the `atm`

atm - A clojure atom.
path - a vector location within the `atm` where the Firestore `reference` will be written.
reference - a reference to a location in Firestore.

Note that the the {path reference} will show up under the :firemore key, and the
{path reference-value} will show up under the :firemore key in `atm`.

source raw docstring

clj->fire^cljs

(clj->fire document)

Returns a javascript object from the firemore document (a clojure map).

Returns a javascript object from the firemore `document` (a clojure map).

source raw docstring

delete!^cljs

(delete! reference)

Deletes the document at reference within the Firestore database.

Returns a channel. Iff an error occurs when deleting reference from Firestore, then the error will be put upon the channel. The channel will then be closed.

Note: channel -> clojure.core.async/chan put -> clojure.core.async/put! closed -> clojure.core.async/close!

Deletes the document at `reference` within the Firestore database.

Returns a channel. Iff an error occurs when deleting reference from Firestore,
then the error will be put upon the channel. The channel will then be closed.

Note:
channel -> `clojure.core.async/chan`
put     -> `clojure.core.async/put!`
closed  -> `clojure.core.async/close!`

source raw docstring

delete-user!^cljs

(delete-user!)

Deletes the currently logged in user from Firestore.

This removes all sign-in providers for this user, as well as deleting the data in the user information map returned by (get-user-atom). Note that this does NOT delete information relating to the user from the actual Firestore database.

Deletes the currently logged in user from Firestore.

This removes all sign-in providers for this user, as well as deleting the data in the
user information map returned by (get-user-atom). Note that this does NOT delete
information relating to the user from the actual Firestore database.

source raw docstring

fire->clj^cljs

(fire->clj js-object)

Returns the clojure form of the js-object document from Firestore.

Returns the clojure form of the `js-object` document from Firestore.

source raw docstring

get^cljs

(get reference)

Get the document at reference in the Firestore database.

Returns a channel. A map representing the data at this location will be put on this channel. The channel will then be closed.

Note: channel -> clojure.core.async/chan put -> clojure.core.async/put! closed -> clojure.core.async/close!

Get the document at `reference` in the Firestore database.

Returns a channel. A map representing the data at this location will be put
on this channel. The channel will then be closed.

Note:
channel -> `clojure.core.async/chan`
put    -> `clojure.core.async/put!`
closed  -> `clojure.core.async/close!`

source raw docstring

(login-anonymously!)

logout!^cljs

(logout!)

merge!^cljs

(merge! reference document)

Merges document into the document at reference within the Firestore database.

Returns a channel. Updates (merges) the document at reference with document. Iff an error occurs when writing document to Firestore, then the error will be put upon the channel. The channel will then be closed.

Note: channel -> clojure.core.async/chan put -> clojure.core.async/put! closed -> clojure.core.async/close!

Merges `document` into the document at `reference` within the Firestore database.

Returns a channel. Updates (merges) the document at `reference` with `document`.
Iff an error occurs when writing `document` to Firestore, then the error will be put
upon the channel. The channel will then be closed.

Note:
channel -> `clojure.core.async/chan`
put     -> `clojure.core.async/put!`
closed  -> `clojure.core.async/close!`

source raw docstring

push!^cljs

(push! reference document)

Adds the document to collection reference within the Firestore database.

Returns a channel. Creates a new id for document. Either {:id <document-id>} or {:error <error-msg>} will then be placed upon the channel. The channel will then be closed.

Adds the `document` to collection `reference` within the Firestore database.

Returns a channel. Creates a new id for `document`. Either
{:id <document-id>} or {:error <error-msg>} will then be placed upon the
channel. The channel will then be closed.

source raw docstring

subtract!^cljs

(subtract! atm path)

Remove the path from the atm

Remove the `path` from the `atm`

source raw docstring

supported-types^cljs

throw-if-unsupported^cljs

(throw-if-unsupported m)

uid^cljs

(uid)

Returns a channel that will have a uid put! upon it'

If you are currently logged in, uid will be the uid of the currently logged in user. If you are not currently logged in, client will login with the anonymous user, and then the uid will be the uid of the anonymous user.

Note: channel -> clojure.core.async/chan put! -> clojure.core.async/put!

Returns a channel that will have a uid put! upon it'

If you are currently logged in, uid will be the uid of the currently logged
in user. If you are not currently logged in, client will login with the
anonymous user, and then the uid will be the uid of the anonymous user.

Note:
channel -> `clojure.core.async/chan`
put!    -> `clojure.core.async/put!`

source raw docstring

unwatch-user^cljs

(unwatch-user atm)

Removes functionality on atm that may have been added by watch-user

Removes functionality on `atm` that may have been added by `watch-user`

source raw docstring

user^cljs

(user)

Returns the last value returned from user-chan.

Returns the last value returned from user-chan.

source raw docstring

user-atom^cljs

(user-atom)

Return the atom that reflects the state of currently logged in user

Return the atom that reflects the state of currently logged in user

source raw docstring

user-chan^cljs

(user-chan)

Returns a channel. Will put! user map or :firemore/no-user as user state changes..

{:uid <application_unique_id> :email <user_email_address> :name <user_identifier> :photo <url_to_a_photo_for_this_user>}

Note: :uid will always be present. :email, :name, :photo may be present depending on sign-in provider and/or whether you have set their values.

Returns a channel. Will put! user map or :firemore/no-user as user state changes..

  {:uid <application_unique_id>
   :email <user_email_address>
   :name <user_identifier>
   :photo <url_to_a_photo_for_this_user>}

Note: :uid will always be present. :email, :name, :photo may be present depending
on sign-in provider and/or whether you have set their values.

source raw docstring

watch^cljs

(watch reference)

Watch the document at reference in the Firestore database.

Returns a channel. A map representing the data at this location will be put on this channel. As the document at reference is updated through time, the channel will put! the newest value of the document upon the channel.

Important: close! the channel to clean up the state machine feeding this channel. Failure to close the channel will result in a memory leak.

Note: channel -> clojure.core.async/chan put -> clojure.core.async/put! closed -> clojure.core.async/close!

Watch the document at `reference` in the Firestore database.

Returns a channel. A map representing the data at this location will be put
on this channel. As the document at reference is updated through time, the
channel will put! the newest value of the document upon the channel.

Important: close! the channel to clean up the state machine feeding this
channel. Failure to close the channel will result in a memory leak.

Note:
channel -> `clojure.core.async/chan`
put     -> `clojure.core.async/put!`
closed  -> `clojure.core.async/close!`

source raw docstring

watch-user^cljs

(watch-user atm)

Add functionality to atom atm so that :user reflects latest value from get-user

Add functionality to atom `atm` so that `:user` reflects latest value from `get-user`

source raw docstring

write!^cljs

(write! reference document)

Writes the document to reference within the Firestore database.

Returns a channel. Overwrites the document at reference with document. Iff an error occurs when writing document to Firestore, then the error will be put upon the channel. The channel will then be closed.

Note: channel -> clojure.core.async/chan put -> clojure.core.async/put! closed -> clojure.core.async/close!

Writes the `document` to `reference` within the Firestore database.

Returns a channel. Overwrites the document at `reference` with `document`.
Iff an error occurs when writing document to Firestore, then the error will
be put upon the channel. The channel will then be closed.

Note:
channel -> `clojure.core.async/chan`
put     -> `clojure.core.async/put!`
closed  -> `clojure.core.async/close!`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub