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

doc: More documentation fixes

Browse Source
This commit is contained in:
haad 2025-05-04 10:06:02 +02:00
parent 05e4250b6b
commit dccbd1c6a2
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/GETTING_STARTED.md
View File

@ -308,4 +308,4 @@ These kinds of connectivity configurations are beyond the scope of OrbitDB. To f
[Replication](./REPLICATION.md) provides a comprehensive overview of how to perform data replication across multiple peers. [Replication](./REPLICATION.md) provides a comprehensive overview of how to perform data replication across multiple peers.
[Replication](./ENCRYPTION.md) discusses database encryption using OrbitDB's modular architecture. [Encryption](./ENCRYPTION.md) discusses database encryption using OrbitDB's modular architecture.

2
src/databases/documents.js
View File

@ -26,7 +26,7 @@ const DefaultOptions = { indexBy: '_id' }
* @memberof module:Databases * @memberof module:Databases
*/ */
const Documents = ({ indexBy } = DefaultOptions) => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encrypt }) => { const Documents = ({ indexBy } = DefaultOptions) => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encrypt }) => {
const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically }) const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, encrypt })
const { addOperation, log } = database const { addOperation, log } = database

2
src/orbitdb.js
View File

@ -104,7 +104,7 @@ const OrbitDB = async ({ ipfs, id, identity, identities, directory } = {}) => {
* @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 {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 number of references to * @param {number} [params.referencesCount] The number of references to
* use for [Log]{@link module:Log} entries. * use for [Log]{@link module:Log} entries.
* @param {number} [params.encryption] Options for encrypting database payloads and entries. If provided, the encryption object must take the form { encryptPayloadFn, decryptPayloadFn, encryptEntryFn, decryptEntryFn }. To encrypt the payload, pass the payload encrypt/decrypt functions. To encrypt the entry, pass the entry encrypt/decrypt functions. To encrypt/decrypt both payload and entry, pass all functions. * @param {number} [params.encryption] Encryption module to encrypt/decrypt database payloads and entries. If provided, the encryption object must take the form { replication: { encrypt, decrypt }, data: { encrypt, decrypt } }.
* @memberof module:OrbitDB * @memberof module:OrbitDB
* @return {module:Database} A database instance. * @return {module:Database} A database instance.
* @throws "Unsupported database type" if the type specified is not in the list * @throws "Unsupported database type" if the type specified is not in the list