quantus/common
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.32.8

Browse Source
This commit is contained in:
Travis CI
2018-10-24 14:06:04 +00:00
parent 0cb6e6c746
commit 0bae9bbb23
157 changed files with 422 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/db/classes/_disk_.diskdb.md
+13 -12
View File
@@ -7,6 +7,7 @@
*__description__*: Create an instance of a Disk database using LruDb (for caching with FileFlatDb) and extending TransactionDb. Note that LruDB uses the [Least Recently Used (LRU) cache algorithm](https://www.npmjs.com/package/lru_map)
*__example__*:
```javascript
import stringToU8a from '@polkadot/util/string/toU8a';
import DiskDb from '@polkadot/db/Disk';
@@ -73,7 +74,7 @@ diskDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/Disk.ts#L66)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/Disk.ts#L66)*
**Parameters:**
@@ -97,7 +98,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -110,7 +111,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -129,7 +130,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -142,7 +143,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -155,7 +156,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -174,7 +175,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -193,7 +194,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -206,7 +207,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -226,7 +227,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -246,7 +247,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -259,7 +260,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_engines_filetreedb_.filetreedb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new FileTreeDb**(location: *`string`*): [FileTreeDb](_engines_filetreedb_.filetreedb.md)
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L21)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
**● _location**: *`string`*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L21)*
___
@@ -48,7 +48,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L46)*
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L46)*
**Returns:** `void`
@@ -59,7 +59,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L76)*
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L76)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L50)*
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L50)*
**Returns:** `void`
@@ -87,7 +87,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L54)*
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L54)*
**Returns:** `void`
@@ -98,7 +98,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L86)*
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L86)*
**Parameters:**
@@ -115,7 +115,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L68)*
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L68)*
**Parameters:**
@@ -132,7 +132,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L42)*
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L42)*
**Returns:** `void`
@@ -143,7 +143,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L100)*
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L100)*
**Parameters:**
@@ -161,7 +161,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L58)*
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L58)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L62)*
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L62)*
**Returns:** `number`
docs/db/classes/_engines_lrudb_.lrudb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new LruDb**(backing: *`BaseDb`*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md)
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L20)*
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L20)*
**Parameters:**
@@ -37,7 +37,7 @@ ___
▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` | `undefined`
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L87)*
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L87)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L27)*
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L27)*
**Returns:** `void`
@@ -65,7 +65,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L64)*
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L64)*
**Parameters:**
@@ -82,7 +82,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L41)*
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L41)*
**Returns:** `void`
@@ -93,7 +93,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L45)*
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L45)*
**Returns:** `void`
@@ -104,7 +104,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L71)*
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L71)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L56)*
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L56)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L34)*
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L34)*
**Returns:** `void`
@@ -149,7 +149,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L91)*
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L91)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L52)*
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L52)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L60)*
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L60)*
**Returns:** `number`
docs/db/classes/_engines_memorydb_.memorydb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new MemoryDb**(options?: *`BaseDbOptions`*): [MemoryDb](_engines_memorydb_.memorydb.md)
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L16)*
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L16)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L22)*
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L22)*
**Returns:** `void`
@@ -47,7 +47,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L56)*
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L56)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L30)*
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L30)*
**Returns:** `void`
@@ -75,7 +75,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L34)*
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L34)*
**Returns:** `void`
@@ -86,7 +86,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L62)*
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L62)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L42)*
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L42)*
**Parameters:**
@@ -120,7 +120,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L26)*
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L26)*
**Returns:** `void`
@@ -131,7 +131,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L68)*
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L68)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L38)*
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L38)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L50)*
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L50)*
**Returns:** `number`
docs/db/classes/_engines_transactiondb_.transactiondb.md
+12 -12
View File
@@ -20,7 +20,7 @@
⊕ **new TransactionDb**(backing: *`BaseDb`*): [TransactionDb](_engines_transactiondb_.transactiondb.md)
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L21)*
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L21)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -51,7 +51,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -68,7 +68,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -79,7 +79,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -135,7 +135,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -153,7 +153,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -182,7 +182,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_fileflatdb_compact_.compact.md
+2 -2
View File
@@ -12,7 +12,7 @@
⊕ **new Compact**(file: *`string`*): [Compact](_fileflatdb_compact_.compact.md)
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/Compact.ts#L17)*
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/Compact.ts#L17)*
**Parameters:**
@@ -32,7 +32,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/Compact.ts#L24)*
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/Compact.ts#L24)*
**Parameters:**
docs/db/classes/_fileflatdb_index_.fileflatdb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new FileFlatDb**(base: *`string`*, file?: *`string`*, options?: *`BaseDbOptions`*): [FileFlatDb](_fileflatdb_index_.fileflatdb.md)
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L32)*
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L32)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
▸ **close**(): `void`
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L58)*
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L58)*
**Returns:** `void`
@@ -49,7 +49,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L105)*
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L105)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
▸ **drop**(): `void`
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L68)*
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L68)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
▸ **empty**(): `void`
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L74)*
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L74)*
**Returns:** `void`
@@ -88,7 +88,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L109)*
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L109)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L97)*
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L97)*
**Parameters:**
@@ -122,7 +122,7 @@ ___
▸ **open**(): `void`
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L48)*
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L48)*
**Returns:** `void`
@@ -133,7 +133,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L127)*
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L127)*
**Parameters:**
@@ -151,7 +151,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L85)*
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L85)*
**Parameters:**
@@ -169,7 +169,7 @@ ___
▸ **size**(): `number`
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L81)*
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L81)*
**Returns:** `number`
docs/db/classes/_memory_.memory.md
+13 -12
View File
@@ -10,6 +10,7 @@
* Disable compression when storing "state" Transactions Trie using @polkadot/trie-db or @polkadot/db/src/engines/TransactionDb.ts (potentially LevelDb or RocksDb implementation of a Merkle Patricia Trie) data structure serialised with Recursive Length Prefix (RLP) encoding
*__example__*:
```javascript
import stringToU8a from '@polkadot/util/string/toU8a';
import MemoryDb from '@polkadot/db/Memory';
@@ -71,7 +72,7 @@ memoryDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/Memory.ts#L66)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/Memory.ts#L66)*
**Parameters:**
@@ -93,7 +94,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -106,7 +107,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -125,7 +126,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -138,7 +139,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -151,7 +152,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -170,7 +171,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -189,7 +190,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -202,7 +203,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -222,7 +223,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -242,7 +243,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -255,7 +256,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**