diff --git a/src/db/documents.js b/src/db/documents.js index b459549..b849fea 100644 --- a/src/db/documents.js +++ b/src/db/documents.js @@ -20,36 +20,6 @@ import Database from '../database.js' const DefaultOptions = { indexBy: '_id' } -/** - * Creates an instance of Documents. - * @callback Documents - * @param {Object} params One or more parameters for configuring Database. - * @param {IPFS} params.ipfs An IPFS instance. - * @param {Identity} [params.identity] An Identity instance. - * @param {string} [params.address] The address of the database. - * @param {string} [params.name] The name of the database. - * @param {module:AccessControllers} [params.access] An AccessController - * instance. - * @param {string} [params.directory] A location for storing Database-related - * data. Defaults to ./orbitdb/[params.address]. - * @param {*} [params.meta={}] The database's metadata. - * @param {module:Storage} [params.headsStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log heads. Defaults to ComposedStorage(LRUStorage, IPFSBlockStorage). - * @param {module:Storage} [params.entryStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {number} [params.referencesCount] The maximum distance between - * references to other entries. - * @param {boolean} [params.syncAutomatically=false] If true, sync databases - * automatically. Otherwise, false. - * @param {function} [params.onUpdate] A function callback. Fired when an - * entry is added to the oplog. - * @function - * @instance - * @async - * @memberof module:Databases.Databases-Documents - */ - /** * Defines a Documents database. * @param {Object} options Various options for configuring the Document store. diff --git a/src/db/events.js b/src/db/events.js index ea862e7..6d05a96 100644 --- a/src/db/events.js +++ b/src/db/events.js @@ -5,36 +5,6 @@ */ import Database from '../database.js' -/** - * Creates an instance of Events. - * @callback Events - * @param {Object} params One or more parameters for configuring Database. - * @param {IPFS} params.ipfs An IPFS instance. - * @param {Identity} [params.identity] An Identity instance. - * @param {string} [params.address] The address of the database. - * @param {string} [params.name] The name of the database. - * @param {module:AccessControllers} [params.access] An AccessController - * instance. - * @param {string} [params.directory] A location for storing Database-related - * data. Defaults to ./orbitdb/[params.address]. - * @param {*} [params.meta={}] The database's metadata. - * @param {module:Storage} [params.headsStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log heads. Defaults to ComposedStorage(LRUStorage, IPFSBlockStorage). - * @param {module:Storage} [params.entryStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {number} [params.referencesCount] The maximum distance between - * references to other entries. - * @param {boolean} [params.syncAutomatically=false] If true, sync databases - * automatically. Otherwise, false. - * @param {function} [params.onUpdate] A function callback. Fired when an - * entry is added to the oplog. - * @function - * @instance - * @async - * @memberof module:Databases.Databases-Events - */ - /** * Defines an Events database. * @return {module:Databases.Databases-Events} A Events function. diff --git a/src/db/keyvalue-indexed.js b/src/db/keyvalue-indexed.js index 31d2dcc..6890e73 100644 --- a/src/db/keyvalue-indexed.js +++ b/src/db/keyvalue-indexed.js @@ -19,36 +19,6 @@ import pathJoin from '../utils/path-join.js' const valueEncoding = 'json' -/** - * Creates an instance of KeyValueIndexed. - * @callback KeyValueIndexed - * @param {Object} params One or more parameters for configuring Database. - * @param {IPFS} params.ipfs An IPFS instance. - * @param {Identity} [params.identity] An Identity instance. - * @param {string} [params.address] The address of the database. - * @param {string} [params.name] The name of the database. - * @param {module:AccessControllers} [params.access] An AccessController - * instance. - * @param {string} [params.directory] A location for storing Database-related - * data. Defaults to ./orbitdb/[params.address]. - * @param {*} [params.meta={}] The database's metadata. - * @param {module:Storage} [params.headsStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log heads. Defaults to ComposedStorage(LRUStorage, IPFSBlockStorage). - * @param {module:Storage} [params.entryStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {number} [params.referencesCount] The maximum distance between - * references to other entries. - * @param {boolean} [params.syncAutomatically=false] If true, sync databases - * automatically. Otherwise, false. - * @param {function} [params.onUpdate] A function callback. Fired when an - * entry is added to the oplog. - * @function - * @instance - * @async - * @memberof module:Databases.Databases-KeyValueIndexed - */ - /** * Defines a KeyValueIndexed database. * @param {Object} options Various options for configuring the KeyValueIndexed diff --git a/src/db/keyvalue.js b/src/db/keyvalue.js index 208a143..c03d880 100644 --- a/src/db/keyvalue.js +++ b/src/db/keyvalue.js @@ -5,36 +5,6 @@ */ import Database from '../database.js' -/** - * Creates an instance of KeyValue. - * @callback KeyValue - * @param {Object} params One or more parameters for configuring Database. - * @param {IPFS} params.ipfs An IPFS instance. - * @param {Identity} [params.identity] An Identity instance. - * @param {string} [params.address] The address of the database. - * @param {string} [params.name] The name of the database. - * @param {module:AccessControllers} [params.access] An AccessController - * instance. - * @param {string} [params.directory] A location for storing Database-related - * data. Defaults to ./orbitdb/[params.address]. - * @param {*} [params.meta={}] The database's metadata. - * @param {module:Storage} [params.headsStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log heads. Defaults to ComposedStorage(LRUStorage, IPFSBlockStorage). - * @param {module:Storage} [params.entryStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing - * log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). - * @param {number} [params.referencesCount] The maximum distance between - * references to other entries. - * @param {boolean} [params.syncAutomatically=false] If true, sync databases - * automatically. Otherwise, false. - * @param {function} [params.onUpdate] A function callback. Fired when an - * entry is added to the oplog. - * @function - * @instance - * @async - * @memberof module:Databases.Databases-KeyValue - */ - /** * Defines an KeyValue database. * @return {module:Databases.Databases-KeyValue} A KeyValue function.