Liking cljdoc? Tell your friends :D

fluree.db.connection-js


authenticatecljs

(authenticate conn account user password)
(authenticate conn account user password expireSeconds)
(authenticate conn account user password expireSeconds syncTo)

Authenticate with Fluree On-Demand

Authenticate with Fluree On-Demand
raw docstring

check-connectioncljs

(check-connection conn)
(check-connection conn opts)

Returns true when the connection is properly configured to access the server. If jwt tokens are used; will also verify that the token has not expired. Otherwise, throws an error.

Returns true when the connection is properly configured to access the server.
If jwt tokens are used; will also verify that the token has not expired.
Otherwise, throws an error.
raw docstring

closecljs

(close conn)

Closes a connection

Closes a connection
raw docstring

close-listenercljs

(close-listener conn ledger key)

Closes a listener.

Closes a listener.
raw docstring

connectcljs

(connect servers-string)
(connect servers-string opts)

Connect to a ledger server using URL address. If using a ledger group, multiple addresses can be supplied, separated by commas.

Connect to a ledger server using URL address. If using a ledger group, multiple addresses can be
supplied, separated by commas.
raw docstring

connect-pcljs

(connect-p servers-string)
(connect-p servers-string opts)

Connect to a ledger server using URL address. If using a ledger group, multiple addresses can be supplied, separated by commas.

Returns a promise that eventually contains the connection object.

Connect to a ledger server using URL address. If using a ledger group, multiple addresses can be
supplied, separated by commas.

Returns a promise that eventually contains the connection object.
raw docstring

dbaas?cljs

(dbaas? conn)

Returns open-api? setting from connection object

Returns open-api? setting from connection object
raw docstring

listencljs

(listen conn ledger key callback)

Listens to all events of a given ledger. Supply a ledger identity, any key, and a two-argument function that will be called with each event.

The key is any arbitrary key, and is only used to close the listener via close-listener, otherwise it is opaque to the listener.

The callback function's first argument is the event header/metadata and the second argument is the event data itself.

Listens to all events of a given ledger. Supply a ledger identity,
any key, and a two-argument function that will be called with each event.

The key is any arbitrary key, and is only used to close the listener via close-listener,
otherwise it is opaque to the listener.

The callback function's first argument is the event header/metadata and the second argument
is the event data itself.
raw docstring

listenerscljs

(listeners conn)

Return a list of listeners currently registered for each ledger along with their respective keys.

Return a list of listeners currently registered for each ledger along with their respective keys.
raw docstring

open-api?cljs

(open-api? conn)

Returns open-api? setting from connection object

Returns open-api? setting from connection object
raw docstring

password-generatecljs

(password-generate conn ledger password map-data)

Generates a password auth record for an existing role, or a user. The user may exist, or if createUser? is true, the user is created.

Returns a promise that eventually contains the token or an exception

Generates a password auth record for an existing role, or a user.
The user may exist, or if createUser? is true, the user is created.

Returns a promise that eventually contains the token or an exception
raw docstring

password-logincljs

(password-login conn ledger password user)
(password-login conn ledger password user auth expire)

Returns a JWT token if successful. Must supply ledger, password and either user or auth identifier. Expire is optional

  • ledger - ledger identifier
  • password - plain-text password
  • user - _user/username (TODO: should allow any _user ident in the future)
  • auth - _auth/id (TODO: should allow any _auth ident in the future)
  • expire - requested time to expire in milliseconds
Returns a JWT token if successful.
Must supply ledger, password and either user or auth identifier.
Expire is optional
- ledger   - ledger identifier
- password - plain-text password
- user     - _user/username (TODO: should allow any _user ident in the future)
- auth     - _auth/id (TODO: should allow any _auth ident in the future)
- expire   - requested time to expire in milliseconds
raw docstring

renew-tokencljs

(renew-token conn jwt)
(renew-token conn jwt expire)

Renews a JWT token if successful.

Returns a promise that eventually contains the token or an exception

Renews a JWT token if successful.

Returns a promise that eventually contains the token or an exception
raw docstring

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

× close