Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-03-30 15:08:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: styling

Browse Source
This commit is contained in:
Kia Rahimian 2018-07-13 14:47:37 -04:00
parent 73013936f3
commit ca78ae7a55
1 changed files with 51 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
API.md
View File

@ -20,55 +20,58 @@ After creating an `OrbitDB` instance , you can access the different data stores.
const db = await orbitdb.keyvalue('profile')
```
- **Public OrbitDB Instance Methods**
- [orbitdb.keyvalue(name|address)](#orbitdbkeyvaluenameaddress)
- [kv.put(key, value)](#putkey-value)
- [kv.set(key, value)](#setkey-value)
- [kv.get(key)](#getkey)
- [orbitdb.log(name|address)](#orbitdblognameaddress)
- [log.add(event)](#addevent)
- [log.get(hash)](#gethash)
- [log.iterator([options])](#iteratoroptions)
- [orbitdb.feed(name|address)](#orbitdbfeednameaddress)
- [feed.add(data)](#adddata)
- [feed.get(hash)](#gethash-1)
- [feed.remove(hash)](#removehash)
- [feed.iterator([options])](#iteratoroptions-1)
- [orbitdb.docs(name|address, options)](#orbitdbdocsnameaddress-options)
- [docs.put(doc)](#putdoc)
- [docs.get(hash)](#getkey-1)
- [docs.query(mapper)](#querymapper)
- [del(key)](#delkey)
- [orbitdb.counter(name|address)](#orbitdbcounternameaddress)
- [counter.value](#value)
- [counter.inc([value])](#incvalue)
- [orbitdb.create(name|address, type, [options])]()
- [orbitdb.open(name|address, [options])]()
- [orbitdb.stop()](#orbitdbstop)
- [orbitdb.disconnect()](orbitdbdisconnect)
- **Static Properties**
- [OrbitDB.databaseTypes](#databasetypes)
- **Static Methods**
- [OrbitDB.isValidType(type)](#isvalidtypetype)
- [OrbitDB.addDatabaseType(type, store)](#adddatabasetypetype-store)
- [OrbitDB.getDatabaseTypes()](#getdatabasetypes)
- [OrbitDB.isValidAddress(address)](#isvalidaddressaddress)
- [OrbitDB.parseAddress(address)](#parseaddressaddress)
**Public OrbitDB Instance Methods**
- [orbitdb.keyvalue(name|address)](#orbitdbkeyvaluenameaddress)
- [kv.put(key, value)](#putkey-value)
- [kv.set(key, value)](#setkey-value)
- [kv.get(key)](#getkey)
- [orbitdb.log(name|address)](#orbitdblognameaddress)
- [log.add(event)](#addevent)
- [log.get(hash)](#gethash)
- [log.iterator([options])](#iteratoroptions)
- [orbitdb.feed(name|address)](#orbitdbfeednameaddress)
- [feed.add(data)](#adddata)
- [feed.get(hash)](#gethash-1)
- [feed.remove(hash)](#removehash)
- [feed.iterator([options])](#iteratoroptions-1)
- [orbitdb.docs(name|address, options)](#orbitdbdocsnameaddress-options)
- [docs.put(doc)](#putdoc)
- [docs.get(hash)](#getkey-1)
- [docs.query(mapper)](#querymapper)
- [del(key)](#delkey)
- [orbitdb.counter(name|address)](#orbitdbcounternameaddress)
- [counter.value](#value)
- [counter.inc([value])](#incvalue)
- [orbitdb.create(name, type, [options])]()
- [orbitdb.open(name|address, [options])]()
- [orbitdb.stop()](#orbitdbstop)
- [orbitdb.disconnect()](orbitdbdisconnect)
- [Store API](#store)
- [store.load()](#storeload)
- [store.close()](#storeclose)
- [store.drop()](#storedrop)
- [store.key](#storekey)
- [store.type](#storetype)
- [Store Events](#storeevents)
- [replicated](#replicated)
- [replicate](#replicate)
- [replicate.progress](#replicateprogress)
- [load](#load-1)
- [load.progress](#loadprogress)
- [ready](#ready)
- [write](#write)
**Static Properties**
- [OrbitDB.databaseTypes](#databasetypes)
**Static Methods**
- [OrbitDB.isValidType(type)](#isvalidtypetype)
- [OrbitDB.addDatabaseType(type, store)](#adddatabasetypetype-store)
- [OrbitDB.getDatabaseTypes()](#getdatabasetypes)
- [OrbitDB.isValidAddress(address)](#isvalidaddressaddress)
- [OrbitDB.parseAddress(address)](#parseaddressaddress)
**[Store API](#store)**
- [store.load()](#storeload)
- [store.close()](#storeclose)
- [store.drop()](#storedrop)
- [store.key](#storekey)
- [store.type](#storetype)
**[Store Events](#storeevents)**
- [replicated](#replicated)
- [replicate](#replicate)
- [replicate.progress](#replicateprogress)
- [load](#load-1)
- [load.progress](#loadprogress)
- [ready](#ready)
- [write](#write)
## Public Instance Methods
### orbitdb.keyvalue(name|address)