com.degel.re-frame-firebase.firestore — com.degel/re-frame-firebase 0.8.0

add-effect cljs

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

clj->CollectionReference cljs

(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

clj->DocumentReference cljs

(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

clj->FieldPath cljs

(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

clj->GetOptions cljs

(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

clj->SetOptions cljs

(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

clj->SnapshotListenOptions cljs

(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

clj->SnapshotOptions cljs

(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

delete-effect cljs

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

delete-field-value cljs

(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)}}}

document-id-field-path cljs

(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"]]}}

DocumentChange->clj cljs

(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

DocumentSnapshot->clj cljs

(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

get-effect cljs

(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]})

on-snapshot cljs

(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]})

on-snapshot-effect cljs

on-snapshot-sub cljs

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

PathReference->clj cljs

(PathReference->clj reference)

QuerySnapshot->clj cljs

(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

server-timestamp cljs

(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)}}

set-effect cljs

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

set-firestore-settings cljs

(set-firestore-settings settings)

SnapshotMetadata->clj cljs

(SnapshotMetadata->clj metadata)

update-effect cljs

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

write-batch-effect cljs

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