Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-10-07 22:57:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Metadata new db vs opening db.

Browse Source
This commit is contained in:
Hayden Young
2023-06-22 00:17:08 +01:00
parent 8f88098ee7
commit 877d6b38ea
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/orbitdb.js
View File

@@ -121,7 +121,8 @@ const OrbitDB = async ({ ipfs, id, identities, directory } = {}) => {
* the name of a new database.
* @param {Object} params One or more database configuration parameters.
* @param {string} [params.type=events] The database's type.
* @param {*} [params.meta={}] The database's metadata.
* @param {*} [params.meta={}] The database's metadata. Only applies when
* creating a database and is not used when opening an existing database.
* @param {boolean} [params.sync=true] If true, sync databases automatically.
* Otherwise, false.
* @param {module:Database} [params.Database=[Events]{@link module:Database.Database-Events}] A Database-compatible