From e191d27832ad74bd4355dcad9b706d561e1a3159 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 20 Sep 2018 15:30:44 -0400 Subject: [PATCH] fix: Spelling errors Generated by https://github.com/codespell-project/codespell. --- API.md | 2 +- GUIDE.md | 4 ++-- src/OrbitDB.js | 2 +- test/multiple-databases.test.js | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/API.md b/API.md index 8b988ea..88f6921 100644 --- a/API.md +++ b/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 diff --git a/GUIDE.md b/GUIDE.md index de9c3bb..f81feed 100644 --- a/GUIDE.md +++ b/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 diff --git a/src/OrbitDB.js b/src/OrbitDB.js index 97efb71..3b22de5 100644 --- a/src/OrbitDB.js +++ b/src/OrbitDB.js @@ -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 diff --git a/test/multiple-databases.test.js b/test/multiple-databases.test.js index d242337..45a632e 100644 --- a/test/multiple-databases.test.js +++ b/test/multiple-databases.test.js @@ -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