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: API docs for new params.

Browse Source
This commit is contained in:
Hayden Young 2023-09-04 00:48:49 +01:00
parent 0a5a6ed1ac
commit 8df135284c
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/orbitdb.js
View File

@ -22,6 +22,9 @@ const DefaultAccessController = IPFSAccessController
* @param {Object} params One or more parameters for configuring OrbitDB.
* @param {IPFS} params.ipfs An IPFS instance.
* @param {string} [params.id] The id of the user to use for this OrbitDB instance.
* @param {module:Identity} [params.identity] An identity instance.
* @param {Function} [params.identityProvider] An initialized identity provider.
* @param {module:Identities} [params.identities] An Identities system instance.
* @param {module:Identities} [params.identities] An Identities system instance.
* @param {string} [params.directory] A location for storing OrbitDB data.
* @return {module:OrbitDB~OrbitDB} An instance of OrbitDB.