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

Clarify Storage api docs

Browse Source
This commit is contained in:
haad 2023-06-30 09:05:22 +03:00
parent 200b215112
commit 81ae09a12b
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/storage/composed.js
View File

@ -2,7 +2,7 @@
* @namespace Storage-Composed * @namespace Storage-Composed
* @memberof module:Storage * @memberof module:Storage
* @description * @description
* ComposedStorage stores data to multiple storage mechanisms. * ComposedStorage stores data to multiple storage backends.
* @example <caption>Store to LRU and Level</caption> * @example <caption>Store to LRU and Level</caption>
* await ComposedStorage(await LRUStorage(), await LevelStorage()) * await ComposedStorage(await LRUStorage(), await LevelStorage())
* @example <caption>Store to memory and IPFS</caption> * @example <caption>Store to memory and IPFS</caption>

2
src/storage/index.js
View File

@ -1,7 +1,7 @@
/** /**
* @module Storage * @module Storage
* @description * @description
* Various storage mechanisms with a common interface. * Storage backends for OrbitDB.
*/ */
export { default as ComposedStorage } from './composed.js' export { default as ComposedStorage } from './composed.js'
export { default as IPFSBlockStorage } from './ipfs-block.js' export { default as IPFSBlockStorage } from './ipfs-block.js'

2
src/storage/memory.js
View File

@ -8,7 +8,7 @@
/** /**
* Creates an instance of MemoryStorage. * Creates an instance of MemoryStorage.
* @function * @function
* @return {module:Storage.Storage-Memory} An instance of LRUStorage. * @return {module:Storage.Storage-Memory} An instance of MemoryStorage.
* @memberof module:Storage * @memberof module:Storage
* @instance * @instance
*/ */