Liking cljdoc? Tell your friends :D

com.degel.re-frame-firebase.firestore


add-effectcljs

(add-effect {:keys [path data on-success on-failure]})
source

clj->CollectionReferencecljs

(clj->CollectionReference path)

Converts a seq of keywords and/or strings into a CollectionReference. The seq represents the path to the collection (e.g. [:path "to" :collection]). See https://firebase.google.com/docs/reference/js/firebase.firestore.CollectionReference

Converts a seq of keywords and/or strings into a CollectionReference.
The seq represents the path to the collection (e.g. [:path "to" :collection]).
See https://firebase.google.com/docs/reference/js/firebase.firestore.CollectionReference
sourceraw docstring

clj->DocumentReferencecljs

(clj->DocumentReference path)

Converts a seq of keywords and/or strings into a DocumentReference. The seq represents the path to the document (e.g. [:path-to "document"]). See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentReference

Converts a seq of keywords and/or strings into a DocumentReference.
The seq represents the path to the document (e.g. [:path-to "document"]).
See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentReference
sourceraw docstring

clj->FieldPathcljs

(clj->FieldPath field-path)

Converts a string/keyword or a seq of string/keywords into a FieldPath. Uses the FieldPath contructor. Only tries conversion if the argument isn't a FieldPath already. Possible arguments: "string.dotted.path", :keyword-path, [:path :in-a :seq], a FieldPath object. See https://firebase.google.com/docs/reference/js/firebase.firestore.FieldPath

Converts a string/keyword or a seq of string/keywords into a FieldPath.
Uses the FieldPath contructor.
Only tries conversion if the argument isn't a FieldPath already.
Possible arguments: "string.dotted.path", :keyword-path, [:path :in-a :seq], a FieldPath object.
See https://firebase.google.com/docs/reference/js/firebase.firestore.FieldPath
sourceraw docstring

clj->GetOptionscljs

(clj->GetOptions get-options)

Converts a clojure-style map into a GetOptions satisfying one. The provided map can contain a :source key with one of the following values: :default, :server or :cache. You can also provide a string like "server". See https://firebase.google.com/docs/reference/js/firebase.firestore.GetOptions

Converts a clojure-style map into a GetOptions satisfying one.
The provided map can contain a :source key with one of the following values:
:default, :server or :cache. You can also provide a string like "server".
See https://firebase.google.com/docs/reference/js/firebase.firestore.GetOptions
sourceraw docstring

clj->SetOptionscljs

(clj->SetOptions set-options)

Converts a clojure-style map into a SetOptions satisfying one. The provided map can contain a :merge key with either true or false, and a :merge-fields key with a seq of field paths to be passed to clj->FieldPath. See https://firebase.google.com/docs/reference/js/firebase.firestore.SetOptions

Converts a clojure-style map into a SetOptions satisfying one.
The provided map can contain a :merge key with either true or false, and a
:merge-fields key with a seq of field paths to be passed to clj->FieldPath.
See https://firebase.google.com/docs/reference/js/firebase.firestore.SetOptions
sourceraw docstring

clj->SnapshotListenOptionscljs

(clj->SnapshotListenOptions snapshot-listen-options)

Converts a clojure-style map into a SnapshotListenOptions satisfying one. The provided map can contain a :include-metadata-changes key with either true or false. See https://firebase.google.com/docs/reference/js/firebase.firestore.SnapshotListenOptions

Converts a clojure-style map into a SnapshotListenOptions satisfying one.
The provided map can contain a :include-metadata-changes key with either true or false.
See https://firebase.google.com/docs/reference/js/firebase.firestore.SnapshotListenOptions
sourceraw docstring

clj->SnapshotOptionscljs

(clj->SnapshotOptions snapshot-options)

Converts a clojure-style map into a SnapshotOptions satisfying one. The provided map can containe a :server-timestamps key with one of the following values: :estimate, :previous or :none. You can also provide a string like "estimate". See https://firebase.google.com/docs/reference/js/firebase.firestore.SnapshotOptions

Converts a clojure-style map into a SnapshotOptions satisfying one.
The provided map can containe a :server-timestamps key with one of the following values:
:estimate, :previous or :none. You can also provide a string like "estimate".
See https://firebase.google.com/docs/reference/js/firebase.firestore.SnapshotOptions
sourceraw docstring

delete-effectcljs

(delete-effect {:keys [path on-success on-failure]})
source

delete-field-valuecljs

(delete-field-value)

Returns a field value to be used to delete a field. See https://firebase.google.com/docs/firestore/manage-data/delete-data#fields When updating a document, you should use this as a field value if you want to delete such field.

Example usage: {:firestore/update {:path [:my "document"] :data {:field-to-delete (delete-field-value)}}}

Returns a field value to be used to delete a field.
See https://firebase.google.com/docs/firestore/manage-data/delete-data#fields
When updating a document, you should use this as a field value if you want to
delete such field.

Example usage:
{:firestore/update {:path [:my "document"]
                    :data {:field-to-delete (delete-field-value)}}}
sourceraw docstring

document-id-field-pathcljs

(document-id-field-path)

Returns a field path which can be used to refer to ID of a document. See https://firebase.google.com/docs/reference/js/firebase.firestore.FieldPath#.documentId It can be used in queries to sort or filter by the document ID.

Example usage: {:firestore/get {:path-collection [:my-collection] :where [[(document-id-field-path) :>= "start"]]}}

Returns a field path which can be used to refer to ID of a document.
See https://firebase.google.com/docs/reference/js/firebase.firestore.FieldPath#.documentId
It can be used in queries to sort or filter by the document ID.

Example usage:
{:firestore/get {:path-collection [:my-collection]
                 :where [[(document-id-field-path) :>= "start"]]}}
sourceraw docstring

DocumentChange->cljcljs

(DocumentChange->clj change)
(DocumentChange->clj change snapshot-options)
(DocumentChange->clj change snapshot-options expose-objects)

Converts a DocumentChange object into a clojure-style map. :doc the DocumentSnapshot converted with DocumentSnapshot->clj. :new-index a number. :old-index a number. :type a string. :object the original DocumentChange if expose-objects argument is set to true (nil otherwise). See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentChange

Converts a DocumentChange object into a clojure-style map.
:doc       the DocumentSnapshot converted with DocumentSnapshot->clj.
:new-index a number.
:old-index a number.
:type      a string.
:object    the original DocumentChange if expose-objects argument
           is set to true (nil otherwise).
See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentChange
sourceraw docstring

DocumentSnapshot->cljcljs

(DocumentSnapshot->clj doc)
(DocumentSnapshot->clj doc snapshot-options)
(DocumentSnapshot->clj doc snapshot-options expose-objects)
(DocumentSnapshot->clj doc snapshot-options expose-objects sure-exists)

Converts a DocumentSnapshot object into a clojure-style map. :data the document's contents (nil if it doesn't exist). :id a string representing document's id. :metadata metadata converted with SnapshotMetadata->clj. :ref the object's path converted with PathReference->clj. :object the original DocumentSnapshot if expose-objects argument is set to true (nil otherwise). See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentSnapshot

Converts a DocumentSnapshot object into a clojure-style map.
:data      the document's contents (nil if it doesn't exist).
:id        a string representing document's id.
:metadata  metadata converted with SnapshotMetadata->clj.
:ref       the object's path converted with PathReference->clj.
:object    the original DocumentSnapshot if expose-objects argument
           is set to true (nil otherwise).
See https://firebase.google.com/docs/reference/js/firebase.firestore.DocumentSnapshot
sourceraw docstring

get-effectcljs

(get-effect {:keys [path-document path-collection where order-by limit start-at
                    start-after end-at end-before doc-changes
                    snapshot-listen-options get-options snapshot-options
                    expose-objects on-success on-failure]})
source

on-snapshotcljs

(on-snapshot {:keys [path-document path-collection where order-by limit start-at
                     start-after end-at end-before doc-changes
                     snapshot-listen-options snapshot-options expose-objects
                     on-next on-error]})
source

on-snapshot-effectcljs

source

on-snapshot-subcljs

(on-snapshot-sub app-db [_ params])
source

PathReference->cljcljs

(PathReference->clj reference)
source

QuerySnapshot->cljcljs

(QuerySnapshot->clj query)
(QuerySnapshot->clj query snapshot-options)
(QuerySnapshot->clj query snapshot-options snapshot-listen-options)
(QuerySnapshot->clj query snapshot-options snapshot-listen-options doc-changes)
(QuerySnapshot->clj query
                    snapshot-options
                    snapshot-listen-options
                    doc-changes
                    expose-objects)

Converts a QuerySnapshot object into a clojure-style map. :docs vector of documents converted with DocumentSnapshot->clj. :metadata metadata converted with SnapshotMetadata->clj. :size the number of documents. :doc-changes vector of DocumentChanges converted with DocumentChange->clj if doc-changes argument is set to true (nil otherwise). :object the original DocumentSnapshot if expose-objects argument is set to true (nil otherwise). See https://firebase.google.com/docs/reference/js/firebase.firestore.QuerySnapshot

Converts a QuerySnapshot object into a clojure-style map.
:docs        vector of documents converted with DocumentSnapshot->clj.
:metadata    metadata converted with SnapshotMetadata->clj.
:size        the number of documents.
:doc-changes vector of DocumentChanges converted with DocumentChange->clj if
             doc-changes argument is set to true (nil otherwise).
:object      the original DocumentSnapshot if expose-objects argument
             is set to true (nil otherwise).
See https://firebase.google.com/docs/reference/js/firebase.firestore.QuerySnapshot
sourceraw docstring

server-timestampcljs

(server-timestamp)

Returns a field value to be used to store the server timestamp. See https://firebase.google.com/docs/firestore/manage-data/add-data#update_fields_in_nested_objects You should use this as a field value when setting/updating/adding a document.

Example usage: {:firestore/add {:path [:some-colection] :data {:name "document-with-timestamp" :timestamp (server-timestamp)}}

Returns a field value to be used to store the server timestamp.
See https://firebase.google.com/docs/firestore/manage-data/add-data#update_fields_in_nested_objects
You should use this as a field value when setting/updating/adding a document.

Example usage:
{:firestore/add {:path [:some-colection]
                 :data {:name "document-with-timestamp"
                        :timestamp (server-timestamp)}}
sourceraw docstring

set-effectcljs

(set-effect {:keys [path data set-options on-success on-failure]})
source

set-firestore-settingscljs

(set-firestore-settings settings)
source

SnapshotMetadata->cljcljs

(SnapshotMetadata->clj metadata)
source

update-effectcljs

(update-effect {:keys [path data on-success on-failure]})
source

write-batch-effectcljs

(write-batch-effect {:keys [operations on-success on-failure]})
source

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

× close