Liking cljdoc? Tell your friends :D

orbitdb.feed


add-eventcljs

Takes a OrbitDB feed database instance and a map with the data to store. Returns a js/Promise that resolves to the hash of the entry (string).

Takes a OrbitDB feed database instance and a map with the data to store.
Returns a js/Promise that resolves to the hash of the entry (string).
sourceraw docstring

collectcljs

Takes an iterator as the argument and evaluates it, returns a vector of results.

Takes an iterator as the argument and evaluates it, returns a vector of results.
sourceraw docstring

feedcljs

(feed orbitdb-instance {:keys [name address opts] :or {opts {}}})

Creates and opens a feed database. Takes an OrbitDB instance and a map with:

:name or :address whether you want to create a new or connect to an existing database.

:opts: a map of options (see orbitdb.core/create-database)

Returns a js/Promise resolving to the instance of the database.

Creates and opens a feed database.
Takes an OrbitDB instance and a map with:

`:name` or `:address` whether you want to create a new or connect to an existing database.

`:opts`: a map of options (see `orbitdb.core/create-database`)

Returns a js/Promise resolving to the instance of the database.
sourceraw docstring

get-eventcljs

Takes an OrbitDB feed database instance and a hash of an entry (string). Returns a map with the contents of that entry.

Takes an OrbitDB feed database instance and a hash of an entry (string).
Returns a map with the contents of that entry.
sourceraw docstring

iteratorcljs

Returns an Array of Objects based on the map of options:

:gt (string): Greater than, takes an item's hash. :gte (string): Greater than or equal to, takes an item's hash. :lt (string): Less than, takes an item's hash. :lte (string): Less than or equal to, takes an item's hash value. :limit (integer): Limiting the entries of result, defaults to 1, and -1 means all items. :reverse (boolean): If set to true will result in reversing the result.

Returns an Array of Objects based on the map of options:

`:gt` (string): Greater than, takes an item's hash.
`:gte` (string): Greater than or equal to, takes an item's hash.
`:lt` (string): Less than, takes an item's hash.
`:lte` (string): Less than or equal to, takes an item's hash value.
`:limit` (integer): Limiting the entries of result, defaults to 1, and -1 means all items.
`:reverse` (boolean): If set to true will result in reversing the result.
sourceraw docstring

remove-eventcljs

(remove-event feed-instance hash)

Removes an item pointed to by the hash value. Returns a Promise that resolves to the hash of the deleted entry.

Removes an item pointed to by the hash value.
Returns a Promise that resolves to the hash of the deleted entry.
sourceraw docstring

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

× close