mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-03-30 15:08:28 +00:00
docs(api): add missing aliases
This commit is contained in:
parent
383f0ce6d2
commit
a4eb5e1c60
15
API.md
15
API.md
@ -29,10 +29,12 @@ const db = await orbitdb.keyvalue('profile')
|
||||
- [kv.put(key, value)](#putkey-value)
|
||||
- [kv.set(key, value)](#setkey-value)
|
||||
- [kv.get(key)](#getkey)
|
||||
- [orbitdb.kvstore(name|address)](#orbitdbkvstorenameaddress)
|
||||
- [orbitdb.log(name|address)](#orbitdblognameaddress)
|
||||
- [log.add(event)](#addevent)
|
||||
- [log.get(hash)](#gethash)
|
||||
- [log.iterator([options])](#iteratoroptions)
|
||||
- [orbitdb.eventlog(name|address)](#orbitdbeventlognameaddress)
|
||||
- [orbitdb.feed(name|address)](#orbitdbfeednameaddress)
|
||||
- [feed.add(data)](#adddata)
|
||||
- [feed.get(hash)](#gethash-1)
|
||||
@ -43,6 +45,7 @@ const db = await orbitdb.keyvalue('profile')
|
||||
- [docs.get(hash)](#getkey-1)
|
||||
- [docs.query(mapper)](#querymapper)
|
||||
- [del(key)](#delkey)
|
||||
- [orbitdb.docstore(name|address, options)](#orbitdbdocstorenameaddress-options)
|
||||
- [orbitdb.counter(name|address)](#orbitdbcounternameaddress)
|
||||
- [counter.value](#value)
|
||||
- [counter.inc([value])](#incvalue)
|
||||
@ -163,6 +166,10 @@ Returns an `Object` with the contents of the entry.
|
||||
// { name: 'Friend' }
|
||||
```
|
||||
|
||||
### orbitdb.kvstore(name|address)
|
||||
|
||||
Alias for [`orbitdb.keyvalue()`](#orbitdbkeyvaluenameaddress)
|
||||
|
||||
### orbitdb.log(name|address)
|
||||
> Creates and opens an eventlog database
|
||||
|
||||
@ -219,6 +226,10 @@ const all = db.iterator({ limit: -1 })
|
||||
// [{ name: 'User1' }]
|
||||
```
|
||||
|
||||
### orbitdb.eventlog(name|address)
|
||||
|
||||
Alias for [`orbitdb.log()`](#orbitdblognameaddress)
|
||||
|
||||
### orbitdb.feed(name|address)
|
||||
> Creates and opens a feed database
|
||||
|
||||
@ -329,6 +340,10 @@ Returns a `Promise` that resolves to the multihash of the entry as a `String`.
|
||||
const hash = await db.del('shamb0t')
|
||||
```
|
||||
|
||||
### orbitdb.docstore(name|address, options)
|
||||
|
||||
Alias for [`orbitdb.docs()`](#orbitdbdocsnameaddress-options)
|
||||
|
||||
### orbitdb.counter(name|address)
|
||||
> Creates and opens a counter database
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user