firebase-cljs Api Documentation

Version: 1.3.0

firebase-cljs.database

FirebaseDatabase

protocol

members

offline

(offline _)

Disconnect from the server (all database operations will be completed offline).

online

(online _)

(Re)connect to the server and synchronize the offline database state with the server state.

get-ref

(get-ref _)(get-ref _ path)

Returns a reference to the root or the specified path.

get-app

(get-app _)

The App associated with the Database service instance.

get-ref-url

(get-ref-url _)(get-ref-url _ url)

Returns a reference to the root or the path specified in url. An exception is thrown if the url is not in the same domain as the current database.

korks->path

(korks->path korks)

MatchboxDatabase

protocol

members

listen-once

(listen-once _ type callback)(listen-once _ korks type callback)

Listen to a Firebase Database Reference event ‘type’ once.

remove!

(remove! _)(remove! _ callback)

Remove a Firebase Database Reference.

listen-promise

(listen-promise _ type callback)(listen-promise _ korks type callback)

Listen to a Firebase Promise Reference by event ‘type’.

merge!

(merge! _ obj)(merge! _ obj callback)

Merge object into a Firebase Database Reference.

conj!

(conj! _ val)(conj! _ val callback)

Conjoin value onto a Firebase Database Reference.

reset!

(reset! _ val)(reset! _ val callback)

Set a Firebase Database Reference value. Accepts reference and promises.

swap!

(swap! _ fn)(swap! _ fn callback)

Swap a Firebase Database Reference value. Accepts reference and promises.

disable-listener!

(disable-listener! _ event)(disable-listener! _ event callback)

Disable a Firebase Database Reference listener by event (or event and callback).

listen

(listen _ type callback)(listen _ korks type callback)(listen _ korks type callback failure)

Listen to a Firebase Database Reference by event ‘type’.

get-in

(get-in _ korks)

Returns a Firebase Database Reference. Takes korks, a sequence of keywordized paths.