diff --git a/src/databases/documents.js b/src/databases/documents.js index bd3d635..f5bece4 100644 --- a/src/databases/documents.js +++ b/src/databases/documents.js @@ -2,20 +2,14 @@ * @namespace Databases-Documents * @memberof module:Databases * @description Documents database. - * @example Create documents db with default options - * import { create } from 'IPFS' - * - * const ipfs = create() - * const Partial = Documents() - * const documents = await Partial({ ipfs }) * @example Create documents db with custom index * import { create } from 'IPFS' + * import { OrbitDB, Documents } from 'orbit-db' * * const ipfs = create() - * const options = { indexBy: 'myCustomId'} - * const Partial = Documents(options) - * const documents = await Partial({ ipfs }) - * + * const orbitdb = await OrbitDB({ ipfs }) + * const db = await orbitdb.open('my-docs', { Database: Documents({ indexBy: 'myCustomId'} ) } + * * @augments module:Databases~Database */ import Database from '../database.js' diff --git a/src/databases/keyvalue-indexed.js b/src/databases/keyvalue-indexed.js index 8eac4fa..8490987 100644 --- a/src/databases/keyvalue-indexed.js +++ b/src/databases/keyvalue-indexed.js @@ -7,11 +7,12 @@ * Key-value pairs are stored to the configured storage. * @example Specify a custom storage * import { create } from 'IPFS' + * import { OrbitDB, KeyValueIndexed, IPFSBlockStorage } from 'orbit-db' * * const ipfs = create() - * const storage = await IPFSBlockStorage() - * const Partial = KeyValueIndexed({ storage }) - * const keyValueIndexed = await Partial({ ipfs }) + * const storage = await IPFSBlockStorage({ ipfs }) + * const orbitdb = await OrbitDB({ ipfs }) + * const db = await orbitdb.open('my-kv', { Database: KeyValueIndexed({ storage }) }) * * @augments module:Databases~Database * @augments module:Databases.Databases-KeyValue