mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-03-30 15:08:28 +00:00
Merge pull request #462 from orbitdb/feat/spelling-errors
fix: Spelling errors
This commit is contained in:
commit
c03e9a2720
2
API.md
2
API.md
@ -90,7 +90,7 @@ const db = await orbitdb.keyvalue('profile')
|
||||
|
||||
Returns a `Promise` that resolves to [a database instance](#store-api). `name` (string) should be the database name, not an OrbitDB address (i.e. `user.posts`). `type` is a supported database type (i.e. `eventlog` or [an added custom type](https://github.com/orbitdb/orbit-db#custom-store-types)). `options` is an object with any of the following properties:
|
||||
- `directory` (string): The directory where data will be stored (Default: uses directory option passed to OrbitDB constructor or `./orbitdb` if none was provided).
|
||||
- `write` (array): An array of hex encoded public keys which are used to set write acces to the database. `["*"]` can be passed in to give write access to everyone. See the [GETTING STARTED](https://github.com/orbitdb/orbit-db/blob/master/GUIDE.md) guide for more info. (Default: uses the OrbitDB instance key `orbitdb.key`, which would give write access only to yourself)
|
||||
- `write` (array): An array of hex encoded public keys which are used to set write access to the database. `["*"]` can be passed in to give write access to everyone. See the [GETTING STARTED](https://github.com/orbitdb/orbit-db/blob/master/GUIDE.md) guide for more info. (Default: uses the OrbitDB instance key `orbitdb.key`, which would give write access only to yourself)
|
||||
- `overwrite` (boolean): Overwrite an existing database (Default: `false`)
|
||||
- `replicate` (boolean): Replicate the database with peers, requires IPFS PubSub. (Default: `true`)
|
||||
```javascript
|
||||
|
4
GUIDE.md
4
GUIDE.md
@ -55,7 +55,7 @@ const OrbitDB = require('orbit-db')
|
||||
// OrbitDB uses Pubsub which is an experimental feature
|
||||
// and need to be turned on manually.
|
||||
// Note that these options need to be passed to IPFS in
|
||||
// all examples in this document even if not specfied so.
|
||||
// all examples in this document even if not specified so.
|
||||
const ipfsOptions = {
|
||||
EXPERIMENTAL: {
|
||||
pubsub: true
|
||||
@ -358,7 +358,7 @@ ipfs1.on('ready', async () => {
|
||||
|
||||
## Custom Stores
|
||||
|
||||
Use a custom store to implement case specifc functionality that is not supported by the default OrbitDB database stores. Then, you can easily add and use your custom store with OrbitDB:
|
||||
Use a custom store to implement case specific functionality that is not supported by the default OrbitDB database stores. Then, you can easily add and use your custom store with OrbitDB:
|
||||
|
||||
```javascript
|
||||
// define custom store type
|
||||
|
@ -272,7 +272,7 @@ class OrbitDB {
|
||||
/*
|
||||
options = {
|
||||
localOnly: false // if set to true, throws an error if database can't be found locally
|
||||
create: false // wether to create the database
|
||||
create: false // whether to create the database
|
||||
type: TODO
|
||||
overwrite: TODO
|
||||
|
||||
|
@ -66,7 +66,7 @@ Object.keys(testAPIs).forEach(API => {
|
||||
let localDatabases = []
|
||||
let remoteDatabases = []
|
||||
|
||||
// Create two IPFS instances and two OrbitDB instaces (2 nodes/peers)
|
||||
// Create two IPFS instances and two OrbitDB instances (2 nodes/peers)
|
||||
before(async () => {
|
||||
config.daemon1.repo = ipfsPath1
|
||||
config.daemon2.repo = ipfsPath2
|
||||
|
Loading…
x
Reference in New Issue
Block a user