diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 23c0e6ea6..30d7f4e72 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -359,7 +359,7 @@ diff --git a/docs/chainspec/modules/_types_.md b/docs/chainspec/modules/_types_.md index 36a85ef1f..1a40c8407 100644 --- a/docs/chainspec/modules/_types_.md +++ b/docs/chainspec/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ Chainspec**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/chainspec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/chainspec/src/types.ts#L5)* #### Type declaration diff --git a/docs/db/SUMMARY.md b/docs/db/SUMMARY.md index 5d50f2514..01a2ff9f5 100644 --- a/docs/db/SUMMARY.md +++ b/docs/db/SUMMARY.md @@ -4,6 +4,7 @@ * [Cache](classes/_fileflatdb_cache_.cache.md) * ["FileFlatDb/Compact"](modules/_fileflatdb_compact_.md) * [Compact](classes/_fileflatdb_compact_.compact.md) +* ["FileFlatDb/Compact.spec"](modules/_fileflatdb_compact_spec_.md) * ["FileFlatDb/File"](modules/_fileflatdb_file_.md) * [File](classes/_fileflatdb_file_.file.md) * ["FileFlatDb/Impl"](modules/_fileflatdb_impl_.md) @@ -13,6 +14,7 @@ * ["FileFlatDb/defaults"](modules/_fileflatdb_defaults_.md) * ["FileFlatDb/index"](modules/_fileflatdb_index_.md) * [FileFlatDb](classes/_fileflatdb_index_.fileflatdb.md) +* ["FileFlatDb/index.spec"](modules/_fileflatdb_index_spec_.md) * ["FileFlatDb/types"](modules/_fileflatdb_types_.md) * [Slot](enums/_fileflatdb_types_.slot.md) * ["Memory"](modules/_memory_.md) @@ -21,10 +23,12 @@ * [FileTreeDb](classes/_engines_filetreedb_.filetreedb.md) * ["engines/LruDb"](modules/_engines_lrudb_.md) * [LruDb](classes/_engines_lrudb_.lrudb.md) +* ["engines/LruDb.spec"](modules/_engines_lrudb_spec_.md) * ["engines/MemoryDb"](modules/_engines_memorydb_.md) * [MemoryDb](classes/_engines_memorydb_.memorydb.md) * ["engines/TransactionDb"](modules/_engines_transactiondb_.md) * [TransactionDb](classes/_engines_transactiondb_.transactiondb.md) +* ["engines/TransactionDb.spec"](modules/_engines_transactiondb_spec_.md) * ["types"](modules/_types_.md) * [BaseDb](interfaces/_types_.basedb.md) * [TxDb](interfaces/_types_.txdb.md) diff --git a/docs/db/classes/_disk_.diskdb.md b/docs/db/classes/_disk_.diskdb.md index 167bd2123..13fda55df 100644 --- a/docs/db/classes/_disk_.diskdb.md +++ b/docs/db/classes/_disk_.diskdb.md @@ -74,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/06cc692/packages/db/src/Disk.ts#L66)* +*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/Disk.ts#L66)* **Parameters:** @@ -100,7 +100,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/06cc692/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -115,7 +115,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/06cc692/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -136,7 +136,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/06cc692/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -151,7 +151,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/06cc692/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -166,7 +166,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/06cc692/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -187,7 +187,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/06cc692/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -208,7 +208,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/06cc692/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -223,7 +223,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/06cc692/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -245,7 +245,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/06cc692/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -267,7 +267,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/06cc692/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -280,7 +280,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/06cc692/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/classes/_engines_filetreedb_.filetreedb.md b/docs/db/classes/_engines_filetreedb_.filetreedb.md index 9383f53bd..e4d27abdb 100644 --- a/docs/db/classes/_engines_filetreedb_.filetreedb.md +++ b/docs/db/classes/_engines_filetreedb_.filetreedb.md @@ -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/06cc692/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/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/06cc692/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L21)* ___ @@ -50,7 +50,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L46)* +*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L46)* **Returns:** `void` @@ -63,7 +63,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L76)* +*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L76)* **Parameters:** @@ -82,7 +82,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L50)* +*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L50)* **Returns:** `void` @@ -95,7 +95,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L54)* +*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L54)* **Returns:** `void` @@ -108,7 +108,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L86)* +*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L86)* **Parameters:** @@ -127,7 +127,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L68)* +*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L68)* **Parameters:** @@ -146,7 +146,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L42)* +*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L42)* **Returns:** `void` @@ -159,7 +159,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L100)* +*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L100)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L58)* +*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L58)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/FileTreeDb.ts#L62)* +*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/FileTreeDb.ts#L62)* **Returns:** `number` diff --git a/docs/db/classes/_engines_lrudb_.lrudb.md b/docs/db/classes/_engines_lrudb_.lrudb.md index d57e84d14..cf4c75b3a 100644 --- a/docs/db/classes/_engines_lrudb_.lrudb.md +++ b/docs/db/classes/_engines_lrudb_.lrudb.md @@ -16,7 +16,7 @@ ⊕ **new LruDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md) -*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L20)* +*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/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/06cc692/packages/db/src/engines/LruDb.ts#L87)* +*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L87)* **Parameters:** @@ -56,7 +56,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L27)* +*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L27)* **Returns:** `void` @@ -69,7 +69,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L64)* +*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L64)* **Parameters:** @@ -88,7 +88,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L41)* +*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L41)* **Returns:** `void` @@ -101,7 +101,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L45)* +*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L45)* **Returns:** `void` @@ -114,7 +114,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L71)* +*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L71)* **Parameters:** @@ -133,7 +133,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L56)* +*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L56)* **Parameters:** @@ -152,7 +152,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L34)* +*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L34)* **Returns:** `void` @@ -165,7 +165,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L91)* +*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L91)* **Parameters:** @@ -185,7 +185,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L52)* +*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L52)* **Parameters:** @@ -205,7 +205,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/LruDb.ts#L60)* +*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/LruDb.ts#L60)* **Returns:** `number` diff --git a/docs/db/classes/_engines_memorydb_.memorydb.md b/docs/db/classes/_engines_memorydb_.memorydb.md index 8c0f49bc6..f5a1300e4 100644 --- a/docs/db/classes/_engines_memorydb_.memorydb.md +++ b/docs/db/classes/_engines_memorydb_.memorydb.md @@ -16,7 +16,7 @@ ⊕ **new MemoryDb**(options?: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [MemoryDb](_engines_memorydb_.memorydb.md) -*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L16)* +*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L16)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L22)* +*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L22)* **Returns:** `void` @@ -51,7 +51,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L56)* +*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L56)* **Parameters:** @@ -70,7 +70,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L30)* +*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L30)* **Returns:** `void` @@ -83,7 +83,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L34)* +*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L34)* **Returns:** `void` @@ -96,7 +96,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L62)* +*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L62)* **Parameters:** @@ -115,7 +115,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L42)* +*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L42)* **Parameters:** @@ -134,7 +134,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L26)* +*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L26)* **Returns:** `void` @@ -147,7 +147,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L68)* +*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L68)* **Parameters:** @@ -167,7 +167,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L38)* +*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L38)* **Parameters:** @@ -187,7 +187,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/MemoryDb.ts#L50)* +*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/MemoryDb.ts#L50)* **Returns:** `number` diff --git a/docs/db/classes/_engines_transactiondb_.transactiondb.md b/docs/db/classes/_engines_transactiondb_.transactiondb.md index 3e5ce0050..14b473aae 100644 --- a/docs/db/classes/_engines_transactiondb_.transactiondb.md +++ b/docs/db/classes/_engines_transactiondb_.transactiondb.md @@ -20,7 +20,7 @@ ⊕ **new TransactionDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*): [TransactionDb](_engines_transactiondb_.transactiondb.md) -*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L21)* +*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L21)* **Parameters:** @@ -42,7 +42,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[close](../interfaces/_types_.txdb.md#close)* -*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -55,7 +55,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[del](../interfaces/_types_.txdb.md#del)* -*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -74,7 +74,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[drop](../interfaces/_types_.txdb.md#drop)* -*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -87,7 +87,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[empty](../interfaces/_types_.txdb.md#empty)* -*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -100,7 +100,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[get](../interfaces/_types_.txdb.md#get)* -*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -119,7 +119,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[maintain](../interfaces/_types_.txdb.md#maintain)* -*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -138,7 +138,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[open](../interfaces/_types_.txdb.md#open)* -*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -151,7 +151,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[put](../interfaces/_types_.txdb.md#put)* -*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -171,7 +171,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[rename](../interfaces/_types_.txdb.md#rename)* -*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -191,7 +191,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[size](../interfaces/_types_.txdb.md#size)* -*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -202,7 +202,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_cache_.cache.md b/docs/db/classes/_fileflatdb_cache_.cache.md index a95ff684c..866e2d082 100644 --- a/docs/db/classes/_fileflatdb_cache_.cache.md +++ b/docs/db/classes/_fileflatdb_cache_.cache.md @@ -18,7 +18,7 @@ *Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)* -*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/Cache.ts#L15)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_compact_.compact.md b/docs/db/classes/_fileflatdb_compact_.compact.md index cc800acb7..56c817b78 100644 --- a/docs/db/classes/_fileflatdb_compact_.compact.md +++ b/docs/db/classes/_fileflatdb_compact_.compact.md @@ -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/06cc692/packages/db/src/FileFlatDb/Compact.ts#L17)* +*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/Compact.ts#L17)* **Parameters:** @@ -32,7 +32,7 @@ ___ ▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void` -*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/Compact.ts#L24)* +*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/Compact.ts#L24)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_file_.file.md b/docs/db/classes/_fileflatdb_file_.file.md index 17f70de6b..978a40a9a 100644 --- a/docs/db/classes/_fileflatdb_file_.file.md +++ b/docs/db/classes/_fileflatdb_file_.file.md @@ -16,7 +16,7 @@ ⊕ **new File**(base: *`string`*, file: *`string`*, options: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [File](_fileflatdb_file_.file.md) -*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/File.ts#L19)* +*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/File.ts#L19)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_impl_.impl.md b/docs/db/classes/_fileflatdb_impl_.impl.md index 74044c771..83efee704 100644 --- a/docs/db/classes/_fileflatdb_impl_.impl.md +++ b/docs/db/classes/_fileflatdb_impl_.impl.md @@ -20,7 +20,7 @@ *Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)* -*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/Cache.ts#L15)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_index_.fileflatdb.md b/docs/db/classes/_fileflatdb_index_.fileflatdb.md index 2495b34aa..b4d2fefea 100644 --- a/docs/db/classes/_fileflatdb_index_.fileflatdb.md +++ b/docs/db/classes/_fileflatdb_index_.fileflatdb.md @@ -20,7 +20,7 @@ *Overrides [Cache](_fileflatdb_cache_.cache.md).[constructor](_fileflatdb_cache_.cache.md#constructor)* -*Defined in [FileFlatDb/index.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L18)* +*Defined in [FileFlatDb/index.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L18)* **Parameters:** @@ -44,7 +44,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [FileFlatDb/index.ts:31](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L31)* +*Defined in [FileFlatDb/index.ts:31](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L31)* **Returns:** `void` @@ -57,7 +57,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L74)* +*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L74)* **Parameters:** @@ -76,7 +76,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [FileFlatDb/index.ts:39](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L39)* +*Defined in [FileFlatDb/index.ts:39](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L39)* **Returns:** `void` @@ -89,7 +89,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [FileFlatDb/index.ts:45](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L45)* +*Defined in [FileFlatDb/index.ts:45](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L45)* **Returns:** `void` @@ -102,7 +102,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [FileFlatDb/index.ts:78](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L78)* +*Defined in [FileFlatDb/index.ts:78](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L78)* **Parameters:** @@ -121,7 +121,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [FileFlatDb/index.ts:66](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L66)* +*Defined in [FileFlatDb/index.ts:66](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L66)* **Parameters:** @@ -140,7 +140,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [FileFlatDb/index.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L23)* +*Defined in [FileFlatDb/index.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L23)* **Returns:** `void` @@ -153,7 +153,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [FileFlatDb/index.ts:96](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L96)* +*Defined in [FileFlatDb/index.ts:96](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L96)* **Parameters:** @@ -173,7 +173,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [FileFlatDb/index.ts:55](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L55)* +*Defined in [FileFlatDb/index.ts:55](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L55)* **Parameters:** @@ -193,7 +193,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [FileFlatDb/index.ts:51](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/index.ts#L51)* +*Defined in [FileFlatDb/index.ts:51](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/index.ts#L51)* **Returns:** `number` diff --git a/docs/db/classes/_memory_.memory.md b/docs/db/classes/_memory_.memory.md index 52d2d43d5..c9d2924cd 100644 --- a/docs/db/classes/_memory_.memory.md +++ b/docs/db/classes/_memory_.memory.md @@ -72,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/06cc692/packages/db/src/Memory.ts#L66)* +*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/Memory.ts#L66)* **Parameters:** @@ -96,7 +96,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/06cc692/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -111,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/06cc692/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -132,7 +132,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/06cc692/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -147,7 +147,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/06cc692/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -162,7 +162,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/06cc692/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -183,7 +183,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/06cc692/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -204,7 +204,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/06cc692/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -219,7 +219,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/06cc692/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -241,7 +241,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/06cc692/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -263,7 +263,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/06cc692/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -276,7 +276,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/06cc692/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/enums/_fileflatdb_types_.slot.md b/docs/db/enums/_fileflatdb_types_.slot.md index c2cefd0da..29df05fb2 100644 --- a/docs/db/enums/_fileflatdb_types_.slot.md +++ b/docs/db/enums/_fileflatdb_types_.slot.md @@ -18,7 +18,7 @@ **BRANCH**: = 1 -*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L7)* +*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L7)* ___ @@ -27,7 +27,7 @@ ___ **EMPTY**: = 0 -*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L6)* +*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L6)* ___ @@ -36,7 +36,7 @@ ___ **LEAF**: = 2 -*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L8)* +*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L8)* ___ diff --git a/docs/db/interfaces/_types_.basedb.md b/docs/db/interfaces/_types_.basedb.md index 956774177..8340bcf95 100644 --- a/docs/db/interfaces/_types_.basedb.md +++ b/docs/db/interfaces/_types_.basedb.md @@ -21,7 +21,7 @@ ▸ **close**(): `void` -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -32,7 +32,7 @@ ___ ▸ **del**(key: *`Uint8Array`*): `void` -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L26)* **Parameters:** @@ -49,7 +49,7 @@ ___ ▸ **drop**(): `void` -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -60,7 +60,7 @@ ___ ▸ **empty**(): `void` -*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -71,7 +71,7 @@ ___ ▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L27)* **Parameters:** @@ -88,7 +88,7 @@ ___ ▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void` -*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L22)* **Parameters:** @@ -105,7 +105,7 @@ ___ ▸ **open**(): `void` -*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -116,7 +116,7 @@ ___ ▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void` -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L28)* **Parameters:** @@ -134,7 +134,7 @@ ___ ▸ **rename**(base: *`string`*, file: *`string`*): `void` -*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L23)* **Parameters:** @@ -152,7 +152,7 @@ ___ ▸ **size**(): `number` -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L24)* **Returns:** `number` diff --git a/docs/db/interfaces/_types_.txdb.md b/docs/db/interfaces/_types_.txdb.md index 6967410a1..b5058bb6b 100644 --- a/docs/db/interfaces/_types_.txdb.md +++ b/docs/db/interfaces/_types_.txdb.md @@ -22,7 +22,7 @@ *Inherited from [BaseDb](_types_.basedb.md).[close](_types_.basedb.md#close)* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -35,7 +35,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[del](_types_.basedb.md#del)* -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L26)* **Parameters:** @@ -54,7 +54,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[drop](_types_.basedb.md#drop)* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -67,7 +67,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[empty](_types_.basedb.md#empty)* -*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -80,7 +80,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[get](_types_.basedb.md#get)* -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L27)* **Parameters:** @@ -99,7 +99,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[maintain](_types_.basedb.md#maintain)* -*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L22)* **Parameters:** @@ -118,7 +118,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[open](_types_.basedb.md#open)* -*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -131,7 +131,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[put](_types_.basedb.md#put)* -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L28)* **Parameters:** @@ -151,7 +151,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[rename](_types_.basedb.md#rename)* -*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L23)* **Parameters:** @@ -171,7 +171,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[size](_types_.basedb.md#size)* -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L24)* **Returns:** `number` @@ -182,7 +182,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/db/modules/_engines_lrudb_spec_.md b/docs/db/modules/_engines_lrudb_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/db/modules/_engines_lrudb_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/db/modules/_engines_transactiondb_spec_.md b/docs/db/modules/_engines_transactiondb_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/db/modules/_engines_transactiondb_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/db/modules/_fileflatdb_compact_spec_.md b/docs/db/modules/_fileflatdb_compact_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/db/modules/_fileflatdb_compact_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/db/modules/_fileflatdb_index_spec_.md b/docs/db/modules/_fileflatdb_index_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/db/modules/_fileflatdb_index_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/db/modules/_fileflatdb_types_.md b/docs/db/modules/_fileflatdb_types_.md index 98f3738ad..fdcfce0b7 100644 --- a/docs/db/modules/_fileflatdb_types_.md +++ b/docs/db/modules/_fileflatdb_types_.md @@ -22,7 +22,7 @@ **Ƭ Key**: *`object`* -*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L16)* +*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L16)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ NibbleBuffer**: *`object`* -*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L11)* +*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L11)* #### Type declaration @@ -44,7 +44,7 @@ ___ **Ƭ Value**: *`object`* -*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/FileFlatDb/types.ts#L22)* +*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/FileFlatDb/types.ts#L22)* #### Type declaration diff --git a/docs/db/modules/_types_.md b/docs/db/modules/_types_.md index 1c559bc06..8d41650f0 100644 --- a/docs/db/modules/_types_.md +++ b/docs/db/modules/_types_.md @@ -23,7 +23,7 @@ **Ƭ BaseDbOptions**: *`object`* -*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L13)* #### Type declaration @@ -34,7 +34,7 @@ ___ **Ƭ ProgressCb**: *`function`* -*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L11)* #### Type declaration ▸(progress: *[ProgressValue](_types_.md#progressvalue)*): `void` @@ -54,7 +54,7 @@ ___ **Ƭ ProgressValue**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L5)* #### Type declaration diff --git a/docs/examples/keyring/01_create_account/index.html b/docs/examples/keyring/01_create_account/index.html index 82557a5b4..178351482 100644 --- a/docs/examples/keyring/01_create_account/index.html +++ b/docs/examples/keyring/01_create_account/index.html @@ -393,7 +393,7 @@ diff --git a/docs/examples/keyring/02_load_accounts/index.html b/docs/examples/keyring/02_load_accounts/index.html index 5fac0da9a..07d148597 100644 --- a/docs/examples/keyring/02_load_accounts/index.html +++ b/docs/examples/keyring/02_load_accounts/index.html @@ -405,7 +405,7 @@ diff --git a/docs/examples/keyring/index.html b/docs/examples/keyring/index.html index bd9132daf..a8a3070bb 100644 --- a/docs/examples/keyring/index.html +++ b/docs/examples/keyring/index.html @@ -378,7 +378,7 @@ yarn start diff --git a/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html b/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html index c6bbba1e1..7dc3705c4 100644 --- a/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html +++ b/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html @@ -397,7 +397,7 @@ diff --git a/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html b/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html index 754bfe3b5..0793f177c 100644 --- a/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html +++ b/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html @@ -403,7 +403,7 @@ diff --git a/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html b/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html index d8990f63a..2478b93ea 100644 --- a/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html +++ b/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html @@ -392,7 +392,7 @@ diff --git a/docs/examples/util-crypto/index.html b/docs/examples/util-crypto/index.html index 3b2bda34e..2d31ae966 100644 --- a/docs/examples/util-crypto/index.html +++ b/docs/examples/util-crypto/index.html @@ -378,7 +378,7 @@ yarn start diff --git a/docs/index.html b/docs/index.html index 67eafdf18..653636abd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -415,7 +415,7 @@ diff --git a/docs/keyring/classes/_index_.keyring.md b/docs/keyring/classes/_index_.keyring.md index 379198e51..59bf5a0df 100644 --- a/docs/keyring/classes/_index_.keyring.md +++ b/docs/keyring/classes/_index_.keyring.md @@ -27,7 +27,7 @@ Overview ⊕ **new Keyring**(options: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): [Keyring](_index_.keyring.md) -*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L32)* **Parameters:** @@ -49,7 +49,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[decodeAddress](../interfaces/_types_.keyringinstance.md#decodeaddress)* -*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L43)* ___ @@ -60,7 +60,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[encodeAddress](../interfaces/_types_.keyringinstance.md#encodeaddress)* -*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L44)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[setAddressPrefix](../interfaces/_types_.keyringinstance.md#setaddressprefix)* -*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L45)* ___ @@ -83,7 +83,7 @@ ___ gettype(): [PairType](../modules/_types_.md#pairtype) -*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L50)* +*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L50)* *__description__*: Returns the type of the keyring, either ed25519 of sr25519 @@ -101,12 +101,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)* -*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L72)* +*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L70)* *__name__*: addFromAddress -*__signature__*: addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, defaultEncoded?: Uint8Array): KeyringPair - *__summary__*: Stores an account, given an account address, as a Key/Value (public key, pair) in Keyring Pair Dictionary *__description__*: Allows user to explicitely provide separate inputs including account address or public key, and optionally the associated account metadata, and the default encoded value as arguments (that may be obtained from the json file of an account backup), and then generates a keyring pair from them that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value. @@ -128,12 +126,10 @@ ___ ▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [index.ts:84](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L84)* +*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L81)* *__name__*: addFromJson -*__signature__*: addFromJson ({ address, encoded, meta }: KeyringPair$Json): KeyringPair - *__summary__*: Stores an account, given JSON data, as a Key/Value (public key, pair) in Keyring Pair Dictionary *__description__*: Allows user to provide a json object argument that contains account information (that may be obtained from the json file of an account backup), and then generates a keyring pair from it that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value. @@ -155,12 +151,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)* -*Defined in [index.ts:97](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L97)* +*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L93)* *__name__*: addFromMnemonic -*__signature__*: addFromMnemonic (mnemonic: string, meta?: KeyringPair$Meta): KeyringPair - *__summary__*: Stores an account, given a mnemonic, as a Key/Value (public key, pair) in Keyring Pair Dictionary *__description__*: Allows user to provide a mnemonic (seed phrase that is provided when account is originally created) argument and a metadata argument that contains account information (that may be obtained from the json file of an account backup), and then generates a keyring pair from it that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value. @@ -183,12 +177,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)* -*Defined in [index.ts:109](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L109)* +*Defined in [index.ts:104](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L104)* *__name__*: addFromSeed -*__signature__*: addFromSeed (seed: Uint8Array, meta?: KeyringPair$Meta): KeyringPair - *__summary__*: Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary *__description__*: Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. Allows user to provide the account seed as an argument, and then generates a keyring pair from it that it passes to `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value. @@ -211,12 +203,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)* -*Defined in [index.ts:59](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L59)* +*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L58)* *__name__*: addPair -*__signature__*: addPair (pair: KeyringPair): KeyringPair - *__summary__*: Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary **Parameters:** @@ -236,12 +226,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)* -*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L124)* +*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L118)* *__name__*: getPair -*__signature__*: getPair (address: string | Uint8Array): KeyringPair - *__summary__*: Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address *__description__*: Returns a keyring pair value from the keyring pair dictionary by performing a key lookup using the provided account address or public key (after decoding it). @@ -263,12 +251,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)* -*Defined in [index.ts:134](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L134)* +*Defined in [index.ts:127](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L127)* *__name__*: getPairs -*__signature__*: getPairs (): Array - *__summary__*: Retrieves all account keyring pairs from the Keyring Pair Dictionary *__description__*: Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary. @@ -284,12 +270,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)* -*Defined in [index.ts:144](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L144)* +*Defined in [index.ts:136](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L136)* *__name__*: getPublicKeys -*__signature__*: getPublicKeys (): Array - *__summary__*: Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary *__description__*: Returns an array list of all the public keys associated with each of the keyring pair values that are stored in the keyring pair dictionary. @@ -305,12 +289,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)* -*Defined in [index.ts:157](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L157)* +*Defined in [index.ts:148](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L148)* *__name__*: removePair -*__signature__*: removePair (address: string | Uint8Array): void - *__description__*: Deletes the provided input address or public key from the stored Keyring Pair Dictionary. **Parameters:** @@ -330,12 +312,10 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)* -*Defined in [index.ts:170](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L170)* +*Defined in [index.ts:160](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L160)* *__name__*: toJson -*__signature__*: toJson (address: string | Uint8Array, passphrase?: string): KeyringPair$Json - *__summary__*: Returns a JSON object associated with the input argument that contains metadata assocated with an account *__description__*: Returns a JSON object containing the metadata associated with an account when valid address or public key and when the account passphrase is provided if the account secret is not already unlocked and available in memory. Note that in [Polkadot-JS Apps](https://github.com/polkadot-js/apps) the user may backup their account to a JSON file that contains this information. diff --git a/docs/keyring/classes/_pairs_.pairs.md b/docs/keyring/classes/_pairs_.pairs.md index d8fad6f34..d858abf1b 100644 --- a/docs/keyring/classes/_pairs_.pairs.md +++ b/docs/keyring/classes/_pairs_.pairs.md @@ -16,7 +16,7 @@ ⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md) -*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L17)* +*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L17)* **Returns:** [Pairs](_pairs_.pairs.md) @@ -30,7 +30,7 @@ ___ ▸ **add**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L23)* +*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L23)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **all**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)> -*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L30)* +*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L30)* **Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)> @@ -58,7 +58,7 @@ ___ ▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L34)* +*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L34)* **Parameters:** @@ -75,7 +75,7 @@ ___ ▸ **remove**(address: *`string` | `Uint8Array`*): `void` -*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L49)* +*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L49)* **Parameters:** diff --git a/docs/keyring/index.html b/docs/keyring/index.html index ee1ebb887..8dc899976 100644 --- a/docs/keyring/index.html +++ b/docs/keyring/index.html @@ -397,7 +397,7 @@ diff --git a/docs/keyring/interfaces/_types_.keyringinstance.md b/docs/keyring/interfaces/_types_.keyringinstance.md index 2e8936c80..96fce21a1 100644 --- a/docs/keyring/interfaces/_types_.keyringinstance.md +++ b/docs/keyring/interfaces/_types_.keyringinstance.md @@ -16,7 +16,7 @@ **● type**: *[PairType](../modules/_types_.md#pairtype)* -*Defined in [types.ts:55](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L55)* ___ @@ -28,7 +28,7 @@ ___ ▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L62)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L65)* **Parameters:** @@ -64,7 +64,7 @@ ___ ▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L63)* **Parameters:** @@ -82,7 +82,7 @@ ___ ▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L64)* **Parameters:** @@ -100,7 +100,7 @@ ___ ▸ **addPair**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L61)* **Parameters:** @@ -117,7 +117,7 @@ ___ ▸ **decodeAddress**(encoded: *`string` | `Uint8Array`*): `Uint8Array` -*Defined in [types.ts:57](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L57)* +*Defined in [types.ts:57](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L57)* **Parameters:** @@ -134,7 +134,7 @@ ___ ▸ **encodeAddress**(key: *`Uint8Array` | `string`*): `string` -*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L58)* **Parameters:** @@ -151,7 +151,7 @@ ___ ▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair) -*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L66)* **Parameters:** @@ -168,7 +168,7 @@ ___ ▸ **getPairs**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)> -*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L67)* **Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)> @@ -179,7 +179,7 @@ ___ ▸ **getPublicKeys**(): `Array`<`Uint8Array`> -*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L68)* **Returns:** `Array`<`Uint8Array`> @@ -190,7 +190,7 @@ ___ ▸ **removePair**(address: *`string` | `Uint8Array`*): `void` -*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L69)* **Parameters:** @@ -207,7 +207,7 @@ ___ ▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void` -*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L59)* **Parameters:** @@ -224,7 +224,7 @@ ___ ▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) -*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L70)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpairs.md b/docs/keyring/interfaces/_types_.keyringpairs.md index 01e6a2e7e..902273c52 100644 --- a/docs/keyring/interfaces/_types_.keyringpairs.md +++ b/docs/keyring/interfaces/_types_.keyringpairs.md @@ -16,7 +16,7 @@ **● add**: *`function`* -*Defined in [types.ts:48](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L48)* #### Type declaration ▸(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair) @@ -36,7 +36,7 @@ ___ **● all**: *`function`* -*Defined in [types.ts:49](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L49)* #### Type declaration ▸(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)> @@ -50,7 +50,7 @@ ___ **● get**: *`function`* -*Defined in [types.ts:50](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L50)* #### Type declaration ▸(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair) @@ -70,7 +70,7 @@ ___ **● remove**: *`function`* -*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L51)* #### Type declaration ▸(address: *`string` | `Uint8Array`*): `void` diff --git a/docs/keyring/modules/_address_decode_.md b/docs/keyring/modules/_address_decode_.md index 9821bcef1..60f777763 100644 --- a/docs/keyring/modules/_address_decode_.md +++ b/docs/keyring/modules/_address_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(encoded: *`string` | `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array` -*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/address/decode.ts#L15)* +*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/address/decode.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_address_encode_.md b/docs/keyring/modules/_address_encode_.md index 684bdda18..ea2f57c8d 100644 --- a/docs/keyring/modules/_address_encode_.md +++ b/docs/keyring/modules/_address_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(_key: *`Uint8Array` | `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string` -*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/address/encode.ts#L15)* +*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/address/encode.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_address_setprefix_.md b/docs/keyring/modules/_address_setprefix_.md index f572ee5cc..a0a3ea23f 100644 --- a/docs/keyring/modules/_address_setprefix_.md +++ b/docs/keyring/modules/_address_setprefix_.md @@ -8,7 +8,7 @@ ▸ **setPrefix**(prefix: *[Prefix](_address_types_.md#prefix)*): `void` -*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/address/setPrefix.ts#L9)* +*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/address/setPrefix.ts#L9)* **Parameters:** diff --git a/docs/keyring/modules/_address_types_.md b/docs/keyring/modules/_address_types_.md index cde73b0e8..cbce610d4 100644 --- a/docs/keyring/modules/_address_types_.md +++ b/docs/keyring/modules/_address_types_.md @@ -8,7 +8,7 @@ **Ƭ Prefix**: *`0` | `1` | `3` | `42` | `43` | `68` | `69`* -*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/address/types.ts#L5)* +*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/address/types.ts#L5)* ___ diff --git a/docs/keyring/modules/_pair_decode_.md b/docs/keyring/modules/_pair_decode_.md index b3c8a2e01..6ae38c122 100644 --- a/docs/keyring/modules/_pair_decode_.md +++ b/docs/keyring/modules/_pair_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(passphrase?: *`undefined` | `string`*, _encrypted?: *`Uint8Array` | `null`*): `DecodeResult` -*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/decode.ts#L19)* +*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/decode.ts#L19)* **Parameters:** diff --git a/docs/keyring/modules/_pair_encode_.md b/docs/keyring/modules/_pair_encode_.md index 1a89f7a19..0202ab0cf 100644 --- a/docs/keyring/modules/_pair_encode_.md +++ b/docs/keyring/modules/_pair_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(publicKey: *`Uint8Array`*, seed?: *`Uint8Array` | `null`*, passphrase?: *`undefined` | `string`*): `Uint8Array` -*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/encode.ts#L10)* +*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/encode.ts#L10)* **Parameters:** diff --git a/docs/keyring/modules/_pair_index_.md b/docs/keyring/modules/_pair_index_.md index 113b4c529..fed075ede 100644 --- a/docs/keyring/modules/_pair_index_.md +++ b/docs/keyring/modules/_pair_index_.md @@ -8,7 +8,7 @@ ▸ **pair**(type: *[PairType](_types_.md#pairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](_types_.md#keyringpair) -*Defined in [pair/index.ts:47](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/index.ts#L47)* +*Defined in [pair/index.ts:47](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/index.ts#L47)* *__name__*: pair diff --git a/docs/keyring/modules/_pair_nobody_.md b/docs/keyring/modules/_pair_nobody_.md index 282ea939e..7fb611fec 100644 --- a/docs/keyring/modules/_pair_nobody_.md +++ b/docs/keyring/modules/_pair_nobody_.md @@ -8,7 +8,7 @@ ▸ **everybody**(): [KeyringPair](_types_.md#keyringpair) -*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/nobody.ts#L25)* +*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/nobody.ts#L25)* **Returns:** [KeyringPair](_types_.md#keyringpair) diff --git a/docs/keyring/modules/_pair_tojson_.md b/docs/keyring/modules/_pair_tojson_.md index e3aec37b0..01a84befd 100644 --- a/docs/keyring/modules/_pair_tojson_.md +++ b/docs/keyring/modules/_pair_tojson_.md @@ -8,7 +8,7 @@ ▸ **toJson**(__namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): [KeyringPair$Json](_types_.md#keyringpair_json) -*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/toJson.ts#L15)* +*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/toJson.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_pair_types_.md b/docs/keyring/modules/_pair_types_.md index ee37b1a4d..d92bade7f 100644 --- a/docs/keyring/modules/_pair_types_.md +++ b/docs/keyring/modules/_pair_types_.md @@ -8,7 +8,7 @@ **Ƭ PairInfo**: *`object`* -*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pair/types.ts#L5)* +*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pair/types.ts#L5)* #### Type declaration diff --git a/docs/keyring/modules/_testing_.md b/docs/keyring/modules/_testing_.md index c5d4bde24..5e8756748 100644 --- a/docs/keyring/modules/_testing_.md +++ b/docs/keyring/modules/_testing_.md @@ -8,12 +8,10 @@ ▸ **testKeyring**(options: *[KeyringOptions](_types_.md#keyringoptions)*): [KeyringInstance](../interfaces/_types_.keyringinstance.md) -*Defined in [testing.ts:42](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/testing.ts#L42)* +*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/testing.ts#L41)* *__name__*: testKeyring -*__signature__*: testKeyring (): KeyringInstance - *__summary__*: Create an instance of Keyring pre-populated with locked test accounts *__description__*: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds. diff --git a/docs/keyring/modules/_testingpairs_.md b/docs/keyring/modules/_testingpairs_.md index 55d6f09bf..9ac99ff93 100644 --- a/docs/keyring/modules/_testingpairs_.md +++ b/docs/keyring/modules/_testingpairs_.md @@ -8,7 +8,7 @@ ▸ **testKeyringPairs**(options: *[KeyringOptions](_types_.md#keyringoptions)*): `TestKeyringMap` -*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/testingPairs.ts#L14)* +*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/testingPairs.ts#L14)* **Parameters:** diff --git a/docs/keyring/modules/_types_.md b/docs/keyring/modules/_types_.md index 415347476..5fc358b0b 100644 --- a/docs/keyring/modules/_types_.md +++ b/docs/keyring/modules/_types_.md @@ -27,7 +27,7 @@ **Ƭ KeyringOptions**: *`object`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L9)* #### Type declaration @@ -38,7 +38,7 @@ ___ **Ƭ KeyringPair**: *`object`* -*Defined in [types.ts:33](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L33)* #### Type declaration @@ -49,7 +49,7 @@ ___ **Ƭ KeyringPair$Json**: *`object`* -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L26)* #### Type declaration @@ -60,7 +60,7 @@ ___ **Ƭ KeyringPair$JsonEncoding**: *`object`* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L20)* #### Type declaration @@ -71,7 +71,7 @@ ___ **Ƭ KeyringPair$JsonVersion**: *"0" | "1"* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L18)* ___ @@ -80,7 +80,7 @@ ___ **Ƭ KeyringPair$Meta**: *`object`* -*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L14)* #### Type declaration @@ -93,7 +93,7 @@ ___ **Ƭ PairType**: *"ed25519" | "sr25519"* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/types.ts#L7)* ___ diff --git a/docs/trie-codec/classes/_nodeheader_.extensionheader.md b/docs/trie-codec/classes/_nodeheader_.extensionheader.md index aa87bd67e..c3561d7de 100644 --- a/docs/trie-codec/classes/_nodeheader_.extensionheader.md +++ b/docs/trie-codec/classes/_nodeheader_.extensionheader.md @@ -16,7 +16,7 @@ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)* -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)* -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.leafheader.md b/docs/trie-codec/classes/_nodeheader_.leafheader.md index c594ddca4..35e882c31 100644 --- a/docs/trie-codec/classes/_nodeheader_.leafheader.md +++ b/docs/trie-codec/classes/_nodeheader_.leafheader.md @@ -16,7 +16,7 @@ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)* -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)* -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.nibbleheader.md b/docs/trie-codec/classes/_nodeheader_.nibbleheader.md index d6c4c1cc7..295eb2c8e 100644 --- a/docs/trie-codec/classes/_nodeheader_.nibbleheader.md +++ b/docs/trie-codec/classes/_nodeheader_.nibbleheader.md @@ -16,7 +16,7 @@ ⊕ **new NibbleHeader**(input: *`number`*): [NibbleHeader](_nodeheader_.nibbleheader.md) -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -36,7 +36,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.nodeheader.md b/docs/trie-codec/classes/_nodeheader_.nodeheader.md index 052e83805..a5e155329 100644 --- a/docs/trie-codec/classes/_nodeheader_.nodeheader.md +++ b/docs/trie-codec/classes/_nodeheader_.nodeheader.md @@ -12,7 +12,7 @@ ⊕ **new NodeHeader**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md) -*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L40)* +*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L40)* **Parameters:** @@ -32,7 +32,7 @@ ___ getencodedLength(): `number` -*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L92)* +*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L92)* **Returns:** `number` @@ -43,7 +43,7 @@ ___ getnodeType(): `number` -*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L114)* +*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L114)* **Returns:** `number` @@ -54,7 +54,7 @@ ___ getvalue(): [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md) -*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L118)* +*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L118)* **Returns:** [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md) @@ -68,7 +68,7 @@ ___ ▸ **toU8a**(): `Uint8Array` -*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/NodeHeader.ts#L122)* +*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/NodeHeader.ts#L122)* **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_constants_.md b/docs/trie-codec/modules/_constants_.md index 7d54e764f..ab7649f70 100644 --- a/docs/trie-codec/modules/_constants_.md +++ b/docs/trie-codec/modules/_constants_.md @@ -8,7 +8,7 @@ **● BRANCH_NODE_NO_VALUE**: *`254`* = 254 -*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L10)* +*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L10)* ___ @@ -17,7 +17,7 @@ ___ **● BRANCH_NODE_WITH_VALUE**: *`255`* = 255 -*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L11)* +*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L11)* ___ @@ -26,7 +26,7 @@ ___ **● EMPTY_TRIE**: *`0`* = 0 -*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L5)* +*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L5)* ___ @@ -35,7 +35,7 @@ ___ **● EXTENSION_NODE_BIG**: *`253`* = 253 -*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L9)* ___ @@ -44,7 +44,7 @@ ___ **● EXTENSION_NODE_OFFSET**: *`128`* = 128 -*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L8)* +*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L8)* ___ @@ -53,7 +53,7 @@ ___ **● EXTENSION_NODE_SMALL_MAX**: *`number`* = EXTENSION_NODE_BIG - 1 -*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L15)* +*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L15)* ___ @@ -62,7 +62,7 @@ ___ **● EXTENSION_NODE_THRESHOLD**: *`number`* = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET -*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L13)* +*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L13)* ___ @@ -71,7 +71,7 @@ ___ **● LEAF_NODE_BIG**: *`127`* = 127 -*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L7)* +*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L7)* ___ @@ -80,7 +80,7 @@ ___ **● LEAF_NODE_OFFSET**: *`1`* = 1 -*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L6)* +*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L6)* ___ @@ -89,7 +89,7 @@ ___ **● LEAF_NODE_SMALL_MAX**: *`number`* = LEAF_NODE_BIG - 1 -*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L14)* ___ @@ -98,7 +98,7 @@ ___ **● LEAF_NODE_THRESHOLD**: *`number`* = LEAF_NODE_BIG - LEAF_NODE_OFFSET -*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L12)* +*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L12)* ___ @@ -107,7 +107,7 @@ ___ **● NODE_TYPE_BRANCH**: *`1`* = 1 -*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L17)* +*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L17)* ___ @@ -116,7 +116,7 @@ ___ **● NODE_TYPE_EXT**: *`2`* = 2 -*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L18)* +*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L18)* ___ @@ -125,7 +125,7 @@ ___ **● NODE_TYPE_LEAF**: *`3`* = 3 -*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L19)* +*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L19)* ___ @@ -134,7 +134,7 @@ ___ **● NODE_TYPE_NULL**: *`0`* = 0 -*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/constants.ts#L16)* +*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/constants.ts#L16)* ___ diff --git a/docs/trie-codec/modules/_decode_.md b/docs/trie-codec/modules/_decode_.md index 81736343d..f8308f644 100644 --- a/docs/trie-codec/modules/_decode_.md +++ b/docs/trie-codec/modules/_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(input: *`null` | `Uint8Array`*): `Uint8Array` | `null` | `Array`<`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>> -*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/decode.ts#L95)* +*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/decode.ts#L95)* **Parameters:** diff --git a/docs/trie-codec/modules/_encode_.md b/docs/trie-codec/modules/_encode_.md index 577952165..7afa97eff 100644 --- a/docs/trie-codec/modules/_encode_.md +++ b/docs/trie-codec/modules/_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): `Uint8Array` -*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/encode.ts#L101)* +*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/encode.ts#L101)* **Parameters:** diff --git a/docs/trie-codec/modules/_nibbles_.md b/docs/trie-codec/modules/_nibbles_.md index 40417fa54..4f1655bc6 100644 --- a/docs/trie-codec/modules/_nibbles_.md +++ b/docs/trie-codec/modules/_nibbles_.md @@ -8,7 +8,7 @@ ▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L31)* +*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L31)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **decodeNibbles**(value: *`null` | `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L52)* +*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L52)* **Parameters:** @@ -42,7 +42,7 @@ ___ ▸ **encodeNibbles**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L65)* +*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L65)* **Parameters:** @@ -59,7 +59,7 @@ ___ ▸ **extractKey**(key: *`null` | `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L15)* +*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L15)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **extractNodeKey**(__namedParameters: *[`null` | `Uint8Array`]*): `Uint8Array` -*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L21)* +*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L21)* **Parameters:** @@ -93,7 +93,7 @@ ___ ▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean` -*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L27)* +*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L27)* **Parameters:** @@ -110,7 +110,7 @@ ___ ▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/nibbles.ts#L44)* +*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/nibbles.ts#L44)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createbranch_.md b/docs/trie-codec/modules/_stream_createbranch_.md index a1d70692f..b8f93b01b 100644 --- a/docs/trie-codec/modules/_stream_createbranch_.md +++ b/docs/trie-codec/modules/_stream_createbranch_.md @@ -8,7 +8,7 @@ ▸ **createBranch**(value: *`Uint8Array` | `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array` -*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createBranch.ts#L10)* +*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createBranch.ts#L10)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createempty_.md b/docs/trie-codec/modules/_stream_createempty_.md index e6a5c6f91..2511405f6 100644 --- a/docs/trie-codec/modules/_stream_createempty_.md +++ b/docs/trie-codec/modules/_stream_createempty_.md @@ -8,7 +8,7 @@ ▸ **createEmpty**(): `Uint8Array` -*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createEmpty.ts#L7)* +*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createEmpty.ts#L7)* **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_stream_createextension_.md b/docs/trie-codec/modules/_stream_createextension_.md index 81d49feb5..e7d06e670 100644 --- a/docs/trie-codec/modules/_stream_createextension_.md +++ b/docs/trie-codec/modules/_stream_createextension_.md @@ -8,7 +8,7 @@ ▸ **createExtension**(key: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createExtension.ts#L7)* +*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createExtension.ts#L7)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createleaf_.md b/docs/trie-codec/modules/_stream_createleaf_.md index 812095831..cd6f07f97 100644 --- a/docs/trie-codec/modules/_stream_createleaf_.md +++ b/docs/trie-codec/modules/_stream_createleaf_.md @@ -8,7 +8,7 @@ ▸ **createLeaf**(key: *`Uint8Array`*, value: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createLeaf.ts#L10)* +*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createLeaf.ts#L10)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createsubstream_.md b/docs/trie-codec/modules/_stream_createsubstream_.md index fca8ec99c..b5116e253 100644 --- a/docs/trie-codec/modules/_stream_createsubstream_.md +++ b/docs/trie-codec/modules/_stream_createsubstream_.md @@ -8,7 +8,7 @@ ▸ **createSubstream**(value: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createSubstream.ts#L8)* +*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createSubstream.ts#L8)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createvalue_.md b/docs/trie-codec/modules/_stream_createvalue_.md index ae3389b75..de5dfb134 100644 --- a/docs/trie-codec/modules/_stream_createvalue_.md +++ b/docs/trie-codec/modules/_stream_createvalue_.md @@ -8,7 +8,7 @@ ▸ **createValue**(value: *`null` | `Uint8Array`*): `Uint8Array` -*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/createValue.ts#L9)* +*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/createValue.ts#L9)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_endbranch_.md b/docs/trie-codec/modules/_stream_endbranch_.md index 329043d1c..53183bbc1 100644 --- a/docs/trie-codec/modules/_stream_endbranch_.md +++ b/docs/trie-codec/modules/_stream_endbranch_.md @@ -8,7 +8,7 @@ ▸ **encBranch**(value: *`Uint8Array` | `null`*): `Uint8Array` -*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/stream/endBranch.ts#L7)* +*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/stream/endBranch.ts#L7)* **Parameters:** diff --git a/docs/trie-codec/modules/_types_.md b/docs/trie-codec/modules/_types_.md index e39bc4b4a..73d7e764a 100644 --- a/docs/trie-codec/modules/_types_.md +++ b/docs/trie-codec/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ Codec**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/types.ts#L5)* #### Type declaration diff --git a/docs/trie-codec/modules/_util_fromnibbles_.md b/docs/trie-codec/modules/_util_fromnibbles_.md index 73aa85f61..1fc6591f3 100644 --- a/docs/trie-codec/modules/_util_fromnibbles_.md +++ b/docs/trie-codec/modules/_util_fromnibbles_.md @@ -8,12 +8,10 @@ ▸ **fromNibbles**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [util/fromNibbles.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/util/fromNibbles.ts#L20)* +*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/util/fromNibbles.ts#L19)* *__name__*: fromNibbles -*__signature__*: fromNibbles (nibbles: Uint8Array): Uint8Array - *__summary__*: Converts the input to Nibbles. *__description__*: From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input. diff --git a/docs/trie-codec/modules/_util_fusenibbles_.md b/docs/trie-codec/modules/_util_fusenibbles_.md index 1371ce214..d4d4f835f 100644 --- a/docs/trie-codec/modules/_util_fusenibbles_.md +++ b/docs/trie-codec/modules/_util_fusenibbles_.md @@ -8,7 +8,7 @@ ▸ **fuseNibbles**(nibbles: *`Uint8Array`*, isLeaf: *`boolean`*): `Uint8Array` -*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/util/fuseNibbles.ts#L12)* +*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/util/fuseNibbles.ts#L12)* **Parameters:** diff --git a/docs/trie-codec/modules/_util_sharedprefixlength_.md b/docs/trie-codec/modules/_util_sharedprefixlength_.md index fad9b95fc..058ba182d 100644 --- a/docs/trie-codec/modules/_util_sharedprefixlength_.md +++ b/docs/trie-codec/modules/_util_sharedprefixlength_.md @@ -8,7 +8,7 @@ ▸ **sharedPrefixLength**(first: *`Uint8Array`*, second: *`Uint8Array`*): `number` -*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* +*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* **Parameters:** diff --git a/docs/trie-codec/modules/_util_tonibbles_.md b/docs/trie-codec/modules/_util_tonibbles_.md index 52302978c..8cf9adea5 100644 --- a/docs/trie-codec/modules/_util_tonibbles_.md +++ b/docs/trie-codec/modules/_util_tonibbles_.md @@ -8,12 +8,10 @@ ▸ **toNibbles**(input?: *`Uint8Array` | `null`*): `Uint8Array` -*Defined in [util/toNibbles.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-codec/src/util/toNibbles.ts#L20)* +*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-codec/src/util/toNibbles.ts#L19)* *__name__*: toNibbles -*__signature__*: toNibbles (input: Uint8Array): Uint8Array - *__summary__*: Converts the input to Nibbles. *__description__*: From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input. diff --git a/docs/trie-db/classes/_checkpoint_.checkpoint.md b/docs/trie-db/classes/_checkpoint_.checkpoint.md index 41bfe064c..c37de77b6 100644 --- a/docs/trie-db/classes/_checkpoint_.checkpoint.md +++ b/docs/trie-db/classes/_checkpoint_.checkpoint.md @@ -14,7 +14,7 @@ ⊕ **new Checkpoint**(rootHash: *`Uint8Array`*): [Checkpoint](_checkpoint_.checkpoint.md) -*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/Checkpoint.ts#L7)* +*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/Checkpoint.ts#L7)* **Parameters:** diff --git a/docs/trie-db/classes/_impl_.impl.md b/docs/trie-db/classes/_impl_.impl.md index a6d91db78..dcf7b001c 100644 --- a/docs/trie-db/classes/_impl_.impl.md +++ b/docs/trie-db/classes/_impl_.impl.md @@ -29,7 +29,7 @@ Overview *Overrides [Checkpoint](_checkpoint_.checkpoint.md).[constructor](_checkpoint_.checkpoint.md#constructor)* -*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/Impl.ts#L38)* +*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/Impl.ts#L38)* **Parameters:** @@ -51,7 +51,7 @@ ___ **● db**: *`TxDb`* -*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/Impl.ts#L36)* ___ diff --git a/docs/trie-db/classes/_index_.trie.md b/docs/trie-db/classes/_index_.trie.md index 66fa769c0..ca887d5ce 100644 --- a/docs/trie-db/classes/_index_.trie.md +++ b/docs/trie-db/classes/_index_.trie.md @@ -31,7 +31,7 @@ Overview *Overrides [Impl](_impl_.impl.md).[constructor](_impl_.impl.md#constructor)* -*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L27)* **Parameters:** @@ -57,7 +57,7 @@ ___ *Inherited from [Impl](_impl_.impl.md).[db](_impl_.impl.md#db)* -*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/Impl.ts#L36)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[close](../interfaces/_types_.triedb.md#close)* -*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L58)* +*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L58)* **Returns:** `void` @@ -84,7 +84,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[del](../interfaces/_types_.triedb.md#del)* -*Defined in [index.ts:82](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L82)* +*Defined in [index.ts:82](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L82)* **Parameters:** @@ -103,7 +103,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[drop](../interfaces/_types_.triedb.md#drop)* -*Defined in [index.ts:66](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L66)* **Returns:** `void` @@ -116,7 +116,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[empty](../interfaces/_types_.triedb.md#empty)* -*Defined in [index.ts:62](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L62)* +*Defined in [index.ts:62](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L62)* **Returns:** `void` @@ -129,7 +129,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[get](../interfaces/_types_.triedb.md#get)* -*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L93)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **getNode**(hash?: *`Uint8Array`*): [Node](../modules/_types_.md#node) -*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L124)* +*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L124)* **Parameters:** @@ -165,7 +165,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[getRoot](../interfaces/_types_.triedb.md#getroot)* -*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L114)* +*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L114)* **Returns:** `Uint8Array` @@ -178,7 +178,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[maintain](../interfaces/_types_.triedb.md#maintain)* -*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L70)* **Parameters:** @@ -197,7 +197,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[open](../interfaces/_types_.triedb.md#open)* -*Defined in [index.ts:54](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L54)* **Returns:** `void` @@ -210,7 +210,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[put](../interfaces/_types_.triedb.md#put)* -*Defined in [index.ts:102](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L102)* **Parameters:** @@ -230,7 +230,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[rename](../interfaces/_types_.triedb.md#rename)* -*Defined in [index.ts:74](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L74)* **Parameters:** @@ -250,7 +250,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[setRoot](../interfaces/_types_.triedb.md#setroot)* -*Defined in [index.ts:128](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L128)* +*Defined in [index.ts:128](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L128)* **Parameters:** @@ -269,7 +269,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[size](../interfaces/_types_.triedb.md#size)* -*Defined in [index.ts:78](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L78)* +*Defined in [index.ts:78](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L78)* **Returns:** `number` @@ -282,7 +282,7 @@ ___ *Implementation of [TrieDb](../interfaces/_types_.triedb.md).[snapshot](../interfaces/_types_.triedb.md#snapshot)* -*Defined in [index.ts:133](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L133)* +*Defined in [index.ts:133](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L133)* **Parameters:** @@ -300,7 +300,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/index.ts#L34)* **Parameters:** diff --git a/docs/trie-db/enums/_types_.nodetype.md b/docs/trie-db/enums/_types_.nodetype.md index a06357016..3093a4c35 100644 --- a/docs/trie-db/enums/_types_.nodetype.md +++ b/docs/trie-db/enums/_types_.nodetype.md @@ -19,7 +19,7 @@ **BRANCH**: = 3 -*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L11)* ___ @@ -28,7 +28,7 @@ ___ **EMPTY**: = 0 -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L8)* ___ @@ -37,7 +37,7 @@ ___ **EXTENSION**: = 2 -*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L10)* ___ @@ -46,7 +46,7 @@ ___ **LEAF**: = 1 -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L9)* ___ diff --git a/docs/trie-db/index.html b/docs/trie-db/index.html index 203beb9e6..510d69773 100644 --- a/docs/trie-db/index.html +++ b/docs/trie-db/index.html @@ -401,7 +401,7 @@ diff --git a/docs/trie-db/interfaces/_types_.triedb.md b/docs/trie-db/interfaces/_types_.triedb.md index 650c71a0d..c3ced484b 100644 --- a/docs/trie-db/interfaces/_types_.triedb.md +++ b/docs/trie-db/interfaces/_types_.triedb.md @@ -18,7 +18,7 @@ **● db**: *`TxDb`* -*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L37)* ___ @@ -32,7 +32,7 @@ ___ *Inherited from BaseDb.close* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L18)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -45,7 +45,7 @@ ___ *Inherited from BaseDb.del* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L26)* **Parameters:** @@ -64,7 +64,7 @@ ___ *Inherited from BaseDb.drop* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L20)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -77,7 +77,7 @@ ___ *Inherited from BaseDb.empty* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L21)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -90,7 +90,7 @@ ___ *Inherited from BaseDb.get* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L27)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L27)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **getRoot**(): `Uint8Array` -*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L39)* **Returns:** `Uint8Array` @@ -120,7 +120,7 @@ ___ *Inherited from BaseDb.maintain* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L22)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L22)* **Parameters:** @@ -139,7 +139,7 @@ ___ *Inherited from BaseDb.open* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L19)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -152,7 +152,7 @@ ___ *Inherited from BaseDb.put* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L28)* **Parameters:** @@ -172,7 +172,7 @@ ___ *Inherited from BaseDb.rename* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L23)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L23)* **Parameters:** @@ -190,7 +190,7 @@ ___ ▸ **setRoot**(rootHash: *`Uint8Array`*): `void` -*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L40)* **Parameters:** @@ -209,7 +209,7 @@ ___ *Inherited from BaseDb.size* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L24)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L24)* **Returns:** `number` @@ -220,7 +220,7 @@ ___ ▸ **snapshot**(dest: *[TrieDb](_types_.triedb.md)*, fn: *`ProgressCb`*): `number` -*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L41)* **Parameters:** @@ -240,7 +240,7 @@ ___ *Inherited from TxDb.transaction* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/06cc692/packages/db/src/types.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/trie-db/modules/_constants_.md b/docs/trie-db/modules/_constants_.md index 5ff5709a4..6e6baf575 100644 --- a/docs/trie-db/modules/_constants_.md +++ b/docs/trie-db/modules/_constants_.md @@ -8,7 +8,7 @@ **Ƭ Constants**: *`object`* -*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/constants.ts#L9)* #### Type declaration @@ -22,7 +22,7 @@ ___ ▸ **default**(codec: *`Codec`*): `object` -*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/constants.ts#L14)* **Parameters:** diff --git a/docs/trie-db/modules/_types_.md b/docs/trie-db/modules/_types_.md index 928ec1727..287e900af 100644 --- a/docs/trie-db/modules/_types_.md +++ b/docs/trie-db/modules/_types_.md @@ -31,7 +31,7 @@ **Ƭ EncodedPath**: *`Uint8Array` | `null`* -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L28)* ___ @@ -40,7 +40,7 @@ ___ **Ƭ Node**: *[NodeEmpty](_types_.md#nodeempty) | [NodeNotEmpty](_types_.md#nodenotempty)* -*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L34)* ___ @@ -49,7 +49,7 @@ ___ **Ƭ NodeBranch**: *[[NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L20)* ___ @@ -58,7 +58,7 @@ ___ **Ƭ NodeEmpty**: *`null`* -*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L14)* ___ @@ -67,7 +67,7 @@ ___ **Ƭ NodeEncoded**: *`Uint8Array`* -*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L16)* ___ @@ -76,7 +76,7 @@ ___ **Ƭ NodeEncodedOrEmpty**: *[NodeEncoded](_types_.md#nodeencoded) | [NodeEmpty](_types_.md#nodeempty)* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L18)* ___ @@ -85,7 +85,7 @@ ___ **Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]* -*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L30)* ___ @@ -94,7 +94,7 @@ ___ **Ƭ NodeNotEmpty**: *[NodeKv](_types_.md#nodekv) | [NodeBranch](_types_.md#nodebranch)* -*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/types.ts#L32)* ___ diff --git a/docs/trie-db/modules/_util_is_.md b/docs/trie-db/modules/_util_is_.md index 127e124e7..919290549 100644 --- a/docs/trie-db/modules/_util_is_.md +++ b/docs/trie-db/modules/_util_is_.md @@ -8,12 +8,10 @@ ▸ **isBranchNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:57](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/is.ts#L57)* +*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/is.ts#L52)* *__name__*: isBranchNode -*__signature__*: isBranchNode (node: Node): node is NodeKv - *__summary__*: Returns true if node is an Branch 17-item node *__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) @@ -33,12 +31,10 @@ ___ ▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:17](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/is.ts#L17)* +*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/is.ts#L16)* *__name__*: isEmptyNode -*__signature__*: isEmptyNode (node: Node): node is NodeEmpty - *__summary__*: Returns true if node is NULL *__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) @@ -58,12 +54,10 @@ ___ ▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:37](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/is.ts#L37)* +*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/is.ts#L34)* *__name__*: isExtensionNode -*__signature__*: isExtensionNode (node: Node): node is NodeKv - *__summary__*: Returns true if node is an Extension 2-item node *__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) @@ -83,12 +77,10 @@ ___ ▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/is.ts#L27)* +*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/is.ts#L25)* *__name__*: isKvNode -*__signature__*: isKvNode (node: Node): node is NodeKv - *__summary__*: Returns true if node is not empty and contains a single key/value pair *__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) @@ -108,12 +100,10 @@ ___ ▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:47](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/is.ts#L47)* +*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/is.ts#L43)* *__name__*: isLeafNode -*__signature__*: isLeafNode (node: Node): node is NodeKv - *__summary__*: Returns true if node is an Leaf 2-item node *__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization) diff --git a/docs/trie-db/modules/_util_key_.md b/docs/trie-db/modules/_util_key_.md index d12f332b5..4f1945a4e 100644 --- a/docs/trie-db/modules/_util_key_.md +++ b/docs/trie-db/modules/_util_key_.md @@ -8,7 +8,7 @@ ▸ **computeExtensionKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath) -*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L36)* +*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L36)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **computeLeafKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath) -*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L40)* +*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L40)* **Parameters:** @@ -42,7 +42,7 @@ ___ ▸ **consumeCommonPrefix**(left: *`Uint8Array`*, right: *`Uint8Array`*): [`Uint8Array`, `Uint8Array`, `Uint8Array`] -*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L56)* +*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L56)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **getCommonPrefixLength**(left: *`Uint8Array`*, right: *`Uint8Array`*): `number` -*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L46)* +*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L46)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **keyEquals**(key: *`Uint8Array` | `null`*, test: *`Uint8Array` | `null`*): `boolean` -*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L10)* +*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L10)* **Parameters:** @@ -96,7 +96,7 @@ ___ ▸ **keyStartsWith**(key: *`Uint8Array` | `null`*, partial: *`Uint8Array` | `null`*): `boolean` -*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/key.ts#L20)* +*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/key.ts#L20)* **Parameters:** diff --git a/docs/trie-db/modules/_util_node_.md b/docs/trie-db/modules/_util_node_.md index b67ef27ff..c49e73be9 100644 --- a/docs/trie-db/modules/_util_node_.md +++ b/docs/trie-db/modules/_util_node_.md @@ -8,7 +8,7 @@ ▸ **decodeNode**(codec: *`Codec`*, encoded: *`Uint8Array` | [Node](_types_.md#node)*): [Node](_types_.md#node) -*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/node.ts#L30)* +*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/node.ts#L30)* **Parameters:** @@ -26,7 +26,7 @@ ___ ▸ **encodeNode**(codec: *`Codec`*, node: *[Node](_types_.md#node)*): `Uint8Array` -*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/node.ts#L46)* +*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/node.ts#L46)* **Parameters:** @@ -44,7 +44,7 @@ ___ ▸ **getNodeType**(node: *[Node](_types_.md#node)*): [NodeType](../enums/_types_.nodetype.md) -*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-db/src/util/node.ts#L13)* +*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-db/src/util/node.ts#L13)* **Parameters:** diff --git a/docs/trie-hash/index.html b/docs/trie-hash/index.html index dd6e56b6e..2b88521a1 100644 --- a/docs/trie-hash/index.html +++ b/docs/trie-hash/index.html @@ -391,7 +391,7 @@ diff --git a/docs/trie-hash/modules/_buildtrie_.md b/docs/trie-hash/modules/_buildtrie_.md index 9ebb11576..2ae6f746d 100644 --- a/docs/trie-hash/modules/_buildtrie_.md +++ b/docs/trie-hash/modules/_buildtrie_.md @@ -8,7 +8,7 @@ ▸ **buildTrie**(input: *`Array`<[`Uint8Array`, `Uint8Array`]>*, cursor?: *`number`*, codec?: *`Codec`*, stream?: *`any`*): `Uint8Array` -*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-hash/src/buildTrie.ts#L77)* +*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-hash/src/buildTrie.ts#L77)* **Parameters:** diff --git a/docs/trie-hash/modules/_trieroot_.md b/docs/trie-hash/modules/_trieroot_.md index 8e42ce3d2..664e18be0 100644 --- a/docs/trie-hash/modules/_trieroot_.md +++ b/docs/trie-hash/modules/_trieroot_.md @@ -8,12 +8,10 @@ ▸ **trieRoot**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRoot.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-hash/src/trieRoot.ts#L30)* +*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-hash/src/trieRoot.ts#L29)* *__name__*: trieRoot -*__signature__*: trieRoot (pairs: Trie$Pairs): Uint8Array - *__summary__*: Creates a trie hash from the supplied pairs. *__description__*: From an `Array<{k: Uint8Array, v: Uint8Array}>` input, calculate the triehash and return the result as a `Uint8Array`. diff --git a/docs/trie-hash/modules/_trierootordered_.md b/docs/trie-hash/modules/_trierootordered_.md index 6a9fa0600..7ded085d9 100644 --- a/docs/trie-hash/modules/_trierootordered_.md +++ b/docs/trie-hash/modules/_trierootordered_.md @@ -8,12 +8,10 @@ ▸ **trieRootOrdered**(input: *`Array`<`Uint8Array`>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRootOrdered.ts:31](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-hash/src/trieRootOrdered.ts#L31)* +*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-hash/src/trieRootOrdered.ts#L30)* *__name__*: trieRootOrdered -*__signature__*: trieRootOrdered (values: Array): Uint8Array - *__summary__*: Creates a trie hash from the supplied values. *__description__*: From an `Array` input, calculate the ordered triehash and return the result as a `Uint8Array`. diff --git a/docs/trie-hash/modules/_types_.md b/docs/trie-hash/modules/_types_.md index 18af35ab0..3ddf8119b 100644 --- a/docs/trie-hash/modules/_types_.md +++ b/docs/trie-hash/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ TriePair**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-hash/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-hash/src/types.ts#L5)* #### Type declaration diff --git a/docs/trie-hash/modules/_unhashedtrie_.md b/docs/trie-hash/modules/_unhashedtrie_.md index 9544e828e..0d6f3e59e 100644 --- a/docs/trie-hash/modules/_unhashedtrie_.md +++ b/docs/trie-hash/modules/_unhashedtrie_.md @@ -8,7 +8,7 @@ ▸ **unhashedTrie**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/trie-hash/src/unhashedTrie.ts#L14)* +*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/trie-hash/src/unhashedTrie.ts#L14)* **Parameters:** diff --git a/docs/util-crypto/SUMMARY.md b/docs/util-crypto/SUMMARY.md index 4ef5f59f1..2c16f3fe3 100644 --- a/docs/util-crypto/SUMMARY.md +++ b/docs/util-crypto/SUMMARY.md @@ -1,18 +1,27 @@ * ["blake2/asHex"](modules/_blake2_ashex_.md) +* ["blake2/asHex.spec"](modules/_blake2_ashex_spec_.md) * ["blake2/asU8a"](modules/_blake2_asu8a_.md) +* ["blake2/asU8a.spec"](modules/_blake2_asu8a_spec_.md) * ["blake2/blake2b/asHex"](modules/_blake2_blake2b_ashex_.md) +* ["blake2/blake2b/asHex.spec"](modules/_blake2_blake2b_ashex_spec_.md) * ["blake2/blake2b/asU8a"](modules/_blake2_blake2b_asu8a_.md) +* ["blake2/blake2b/asU8a.spec"](modules/_blake2_blake2b_asu8a_spec_.md) * ["blake2/blake2b/index"](modules/_blake2_blake2b_index_.md) * ["blake2/index"](modules/_blake2_index_.md) * ["index"](modules/_index_.md) * ["keccak/asHex"](modules/_keccak_ashex_.md) +* ["keccak/asHex.spec"](modules/_keccak_ashex_spec_.md) * ["keccak/asU8a"](modules/_keccak_asu8a_.md) +* ["keccak/asU8a.spec"](modules/_keccak_asu8a_spec_.md) * ["keccak/index"](modules/_keccak_index_.md) * ["mnemonic/generate"](modules/_mnemonic_generate_.md) +* ["mnemonic/generate.spec"](modules/_mnemonic_generate_spec_.md) * ["mnemonic/index"](modules/_mnemonic_index_.md) * ["mnemonic/toSecret"](modules/_mnemonic_tosecret_.md) +* ["mnemonic/toSecret.spec"](modules/_mnemonic_tosecret_spec_.md) * ["mnemonic/toSeed"](modules/_mnemonic_toseed_.md) * ["mnemonic/validate"](modules/_mnemonic_validate_.md) +* ["mnemonic/validate.spec"](modules/_mnemonic_validate_spec_.md) * ["nacl/decrypt"](modules/_nacl_decrypt_.md) * ["nacl/decrypt.spec"](modules/_nacl_decrypt_spec_.md) * ["nacl/encrypt"](modules/_nacl_encrypt_.md) @@ -31,8 +40,11 @@ * ["nacl/verify"](modules/_nacl_verify_.md) * ["nacl/verify.spec"](modules/_nacl_verify_spec_.md) * ["random/asHex"](modules/_random_ashex_.md) +* ["random/asHex.spec"](modules/_random_ashex_spec_.md) * ["random/asNumber"](modules/_random_asnumber_.md) +* ["random/asNumber.spec"](modules/_random_asnumber_spec_.md) * ["random/asU8a"](modules/_random_asu8a_.md) +* ["random/asU8a.spec"](modules/_random_asu8a_spec_.md) * ["random/index"](modules/_random_index_.md) * ["schnorrkel/index"](modules/_schnorrkel_index_.md) * ["schnorrkel/keypair/fromRandom"](modules/_schnorrkel_keypair_fromrandom_.md) @@ -45,13 +57,20 @@ * ["schnorrkel/signVerify.spec"](modules/_schnorrkel_signverify_spec_.md) * ["schnorrkel/verify"](modules/_schnorrkel_verify_.md) * ["sha512/asU8a"](modules/_sha512_asu8a_.md) +* ["sha512/asU8a.spec"](modules/_sha512_asu8a_spec_.md) * ["sha512/index"](modules/_sha512_index_.md) * ["types"](modules/_types_.md) * ["xxhash/asHex"](modules/_xxhash_ashex_.md) +* ["xxhash/asHex.spec"](modules/_xxhash_ashex_spec_.md) * ["xxhash/asU8a"](modules/_xxhash_asu8a_.md) +* ["xxhash/asU8a.spec"](modules/_xxhash_asu8a_spec_.md) * ["xxhash/index"](modules/_xxhash_index_.md) * ["xxhash/xxhash64/asBn"](modules/_xxhash_xxhash64_asbn_.md) +* ["xxhash/xxhash64/asBn.spec"](modules/_xxhash_xxhash64_asbn_spec_.md) * ["xxhash/xxhash64/asHex"](modules/_xxhash_xxhash64_ashex_.md) +* ["xxhash/xxhash64/asHex.spec"](modules/_xxhash_xxhash64_ashex_spec_.md) * ["xxhash/xxhash64/asRaw"](modules/_xxhash_xxhash64_asraw_.md) +* ["xxhash/xxhash64/asRaw.spec"](modules/_xxhash_xxhash64_asraw_spec_.md) * ["xxhash/xxhash64/asValue"](modules/_xxhash_xxhash64_asvalue_.md) +* ["xxhash/xxhash64/asValue.spec"](modules/_xxhash_xxhash64_asvalue_spec_.md) * ["xxhash/xxhash64/index"](modules/_xxhash_xxhash64_index_.md) diff --git a/docs/util-crypto/index.html b/docs/util-crypto/index.html index a12e55961..daa1035d9 100644 --- a/docs/util-crypto/index.html +++ b/docs/util-crypto/index.html @@ -485,7 +485,7 @@ diff --git a/docs/util-crypto/modules/_blake2_ashex_.md b/docs/util-crypto/modules/_blake2_ashex_.md index cbbd179f2..e254570d3 100644 --- a/docs/util-crypto/modules/_blake2_ashex_.md +++ b/docs/util-crypto/modules/_blake2_ashex_.md @@ -6,14 +6,12 @@ ## blake2AsHex -▸ **blake2AsHex**(data: *`Uint8Array`*, bitLength?: *`number`*): `string` +▸ **blake2AsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/asHex.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/blake2/asHex.ts#L22)* +*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/blake2/asHex.ts#L21)* *__name__*: blake2AsHex -*__signature__*: blake2AsHex (data: Uint8Array, bitLength: number = 256): string - *__summary__*: Creates a blake2b hex from the input. *__description__*: From a `Uint8Array` input, create the blake2b and return the result as a hex string with the specified `bitLength`. @@ -30,7 +28,7 @@ blake2AsHex('abc'); // => 0xba80a53f981c4d0d | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | - | +| data | `Uint8Array` | `string` | - | | `Default value` bitLength | `number` | 256 | **Returns:** `string` diff --git a/docs/util-crypto/modules/_blake2_ashex_spec_.md b/docs/util-crypto/modules/_blake2_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_blake2_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_blake2_asu8a_.md b/docs/util-crypto/modules/_blake2_asu8a_.md index 1b7106d0e..f151993c3 100644 --- a/docs/util-crypto/modules/_blake2_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_asu8a_.md @@ -6,14 +6,12 @@ ## blake2AsU8a -▸ **blake2AsU8a**(data: *`Uint8Array`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array` +▸ **blake2AsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array` -*Defined in [blake2/asU8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/blake2/asU8a.ts#L22)* +*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/blake2/asU8a.ts#L21)* *__name__*: blake2AsU8a -*__signature__*: blake2AsU8a (data: Uint8Array, bitLength: number = 256): Uint8Array - *__summary__*: Creates a blake2b u8a from the input. *__description__*: From a `Uint8Array` input, create the blake2b and return the result as a u8a with the specified `bitLength`. @@ -30,7 +28,7 @@ blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d] | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | - | +| data | `Uint8Array` | `string` | - | | `Default value` bitLength | `number` | 256 | | `Optional` key | `Uint8Array` | - | diff --git a/docs/util-crypto/modules/_blake2_asu8a_spec_.md b/docs/util-crypto/modules/_blake2_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_blake2_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md index fab6ed8f7..4d0b8b0d3 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md @@ -6,14 +6,12 @@ ## blake2bAsHex -▸ **blake2bAsHex**(data: *`Uint8Array`*, bitLength?: *`number`*): `string` +▸ **blake2bAsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/blake2b/asHex.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/blake2/blake2b/asHex.ts#L24)* +*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* *__name__*: blake2bAsHex -*__signature__*: blake2bAsHex (value: Uint8Array): string - *__summary__*: Creates a blake2b hex string from the input. *__description__*: From a `Uint8Array` input, create the blake2b and return the result as a hex string. @@ -30,7 +28,7 @@ blake2bAsHex('abc'); // => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | - | +| data | `Uint8Array` | `string` | - | | `Default value` bitLength | `number` | 512 | **Returns:** `string` diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_spec_.md b/docs/util-crypto/modules/_blake2_blake2b_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_blake2_blake2b_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md index bf74efa57..863782238 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md @@ -6,14 +6,12 @@ ## blake2bAsU8a -▸ **blake2bAsU8a**(data: *`Uint8Array`*, bitLength?: *`number`*, key?: *`Uint8Array` | `null`*): `Uint8Array` +▸ **blake2bAsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array` | `null`*): `Uint8Array` -*Defined in [blake2/blake2b/asU8a.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L23)* +*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* *__name__*: blake2bAsU8a -*__signature__*: blake2bAsU8a (value: Uint8Array): Uint8Array - *__summary__*: Creates a blake2b Uint8Array from the input. *__description__*: From a `Uint8Array` input, create the blake2b and return the result as a `Uint8Array`. @@ -30,7 +28,7 @@ blake2bAsU8a('abc'); // => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209 | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | - | +| data | `Uint8Array` | `string` | - | | `Default value` bitLength | `number` | 512 | | `Default value` key | `Uint8Array` | `null` | null | diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_spec_.md b/docs/util-crypto/modules/_blake2_blake2b_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_blake2_blake2b_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_keccak_ashex_.md b/docs/util-crypto/modules/_keccak_ashex_.md index 02f13f4b3..7b5ea0918 100644 --- a/docs/util-crypto/modules/_keccak_ashex_.md +++ b/docs/util-crypto/modules/_keccak_ashex_.md @@ -8,12 +8,10 @@ ▸ **keccakAsHex**(value: *`Buffer` | `Uint8Array` | `string`*): `string` -*Defined in [keccak/asHex.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/keccak/asHex.ts#L24)* +*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/keccak/asHex.ts#L23)* *__name__*: keccakAsHex -*__signature__*: keccakAsHex (value: Buffer | Uint8Array | string): string - *__summary__*: Creates a keccak hex string from the input. *__description__*: From either a `string` or a `Buffer` input, create the keccak and return the result as a `0x` prefixed hex string. diff --git a/docs/util-crypto/modules/_keccak_ashex_spec_.md b/docs/util-crypto/modules/_keccak_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_keccak_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_keccak_asu8a_.md b/docs/util-crypto/modules/_keccak_asu8a_.md index 0258bbddb..9fdd2ec04 100644 --- a/docs/util-crypto/modules/_keccak_asu8a_.md +++ b/docs/util-crypto/modules/_keccak_asu8a_.md @@ -8,12 +8,10 @@ ▸ **keccakAsU8a**(value: *`Buffer` | `Uint8Array` | `string`*): `Uint8Array` -*Defined in [keccak/asU8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/keccak/asU8a.ts#L22)* +*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/keccak/asU8a.ts#L21)* *__name__*: keccakAsU8a -*__signature__*: keccakAsU8a (value: Buffer | Uint8Array | string): Uint8Array - *__summary__*: Creates a keccak Uint8Array from the input. *__description__*: From either a `string` or a `Buffer` input, create the keccak and return the result as a `Uint8Array`. diff --git a/docs/util-crypto/modules/_keccak_asu8a_spec_.md b/docs/util-crypto/modules/_keccak_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_keccak_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_mnemonic_generate_.md b/docs/util-crypto/modules/_mnemonic_generate_.md index 1d1102e93..b7c54a895 100644 --- a/docs/util-crypto/modules/_mnemonic_generate_.md +++ b/docs/util-crypto/modules/_mnemonic_generate_.md @@ -8,12 +8,10 @@ ▸ **mnemonicGenerate**(): `string` -*Defined in [mnemonic/generate.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/mnemonic/generate.ts#L20)* +*Defined in [mnemonic/generate.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/mnemonic/generate.ts#L19)* *__name__*: mnemonicGenerate -*__signature__*: mnemonicGenerate (): string - *__summary__*: Creates a valid mnemonic string using using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki). *__example__*: diff --git a/docs/util-crypto/modules/_mnemonic_generate_spec_.md b/docs/util-crypto/modules/_mnemonic_generate_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_mnemonic_generate_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_.md b/docs/util-crypto/modules/_mnemonic_tosecret_.md index 8485bc07e..16440ddd6 100644 --- a/docs/util-crypto/modules/_mnemonic_tosecret_.md +++ b/docs/util-crypto/modules/_mnemonic_tosecret_.md @@ -8,7 +8,7 @@ ▸ **toSecret**(mnemonic: *`string`*): `Uint8Array` -*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* +*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* **Parameters:** diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_spec_.md b/docs/util-crypto/modules/_mnemonic_tosecret_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_mnemonic_tosecret_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_mnemonic_toseed_.md b/docs/util-crypto/modules/_mnemonic_toseed_.md index 57847edb9..a99e9029e 100644 --- a/docs/util-crypto/modules/_mnemonic_toseed_.md +++ b/docs/util-crypto/modules/_mnemonic_toseed_.md @@ -8,12 +8,10 @@ ▸ **toSeed**(mnemonic: *`string`*): `Uint8Array` -*Defined in [mnemonic/toSeed.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/mnemonic/toSeed.ts#L25)* +*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* *__name__*: toSeed -*__signature__*: toSeed (mnemonic: string): Uint8Array - *__summary__*: Creates a valid seed from a mnemonic input *__example__*: diff --git a/docs/util-crypto/modules/_mnemonic_validate_.md b/docs/util-crypto/modules/_mnemonic_validate_.md index 8ccb810ea..a2c4bd71b 100644 --- a/docs/util-crypto/modules/_mnemonic_validate_.md +++ b/docs/util-crypto/modules/_mnemonic_validate_.md @@ -8,12 +8,10 @@ ▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean` -*Defined in [mnemonic/validate.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/mnemonic/validate.ts#L21)* +*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/mnemonic/validate.ts#L20)* *__name__*: mnemonicValidate -*__signature__*: mnemonicValidate (mnemonic: string): boolean - *__summary__*: Validates a mnemonic input using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki). *__example__*: diff --git a/docs/util-crypto/modules/_mnemonic_validate_spec_.md b/docs/util-crypto/modules/_mnemonic_validate_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_mnemonic_validate_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_nacl_decrypt_.md b/docs/util-crypto/modules/_nacl_decrypt_.md index 8896e9df2..2ce22b0f5 100644 --- a/docs/util-crypto/modules/_nacl_decrypt_.md +++ b/docs/util-crypto/modules/_nacl_decrypt_.md @@ -8,12 +8,10 @@ ▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` | `null` -*Defined in [nacl/decrypt.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/decrypt.ts#L22)* +*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/decrypt.ts#L21)* *__name__*: naclDecrypt -*__signature__*: naclDecrypt (message: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array - *__summary__*: Decrypts a message using the supplied secretKey and nonce *__description__*: Returns an decrypted message, using the `secret` and `nonce`. diff --git a/docs/util-crypto/modules/_nacl_encrypt_.md b/docs/util-crypto/modules/_nacl_encrypt_.md index 29b364c1c..d4dff300d 100644 --- a/docs/util-crypto/modules/_nacl_encrypt_.md +++ b/docs/util-crypto/modules/_nacl_encrypt_.md @@ -8,12 +8,10 @@ ▸ **naclEncrypt**(message: *`Uint8Array`*, secret: *`Uint8Array`*, nonce?: *`Uint8Array`*): `Encrypted` -*Defined in [nacl/encrypt.ts:29](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/encrypt.ts#L29)* +*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/encrypt.ts#L28)* *__name__*: naclEncrypt -*__signature__*: naclEncrypt (message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): { encrypted: Uint8Array, nonce: Uint8Array } - *__summary__*: Encrypts a message using the supplied secretKey and nonce *__description__*: Returns an encrypted message, using the `secretKey` and `nonce`. If the `nonce` was not supplied, a random value is generated. diff --git a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md index 98b1c7226..0ec7dd936 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md @@ -8,12 +8,10 @@ ▸ **naclKeypairFromRandom**(): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromRandom.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L24)* +*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* *__name__*: naclKeypairFromRandom -*__signature__*: naclKeypairFromRandom (): { secretKey: Uint8Array, publicKey: Uint8Array } - *__summary__*: Creates a new public/secret keypair. *__description__*: Returns a new generate object containing a `publicKey` & `secretKey`. diff --git a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md index adfe8a751..0e3147f94 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md @@ -8,12 +8,10 @@ ▸ **naclKeypairFromSecret**(secret: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSecret.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L24)* +*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* *__name__*: naclKeypairFromSecret -*__signature__*: naclKeypairFromSecret (secret: Uint8Array): { secretKey: Uint8Array, publicKey: Uint8Array } - *__summary__*: Creates a new public/secret keypair from a secret. *__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied secret. diff --git a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md index 3d3aa69be..8e3077562 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md @@ -8,12 +8,10 @@ ▸ **naclKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSeed.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L24)* +*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* *__name__*: naclKeypairFromSeed -*__signature__*: naclKeypairFromSeed (seed: Uint8Array): { secretKey: Uint8Array, publicKey: Uint8Array } - *__summary__*: Creates a new public/secret keypair from a seed. *__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed. diff --git a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md index 63bacc338..41a7e670f 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md @@ -8,12 +8,10 @@ ▸ **naclKeypairFromString**(value: *`string`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromString.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/keypair/fromString.ts#L27)* +*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* *__name__*: naclKeypairFromString -*__signature__*: naclKeypairFromString (value: string): { secretKey: Uint8Array, publicKey: Uint8Array } - *__summary__*: Creates a new public/secret keypair from a string. *__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied string. The string is hashed and the value used as the input seed. diff --git a/docs/util-crypto/modules/_nacl_sign_.md b/docs/util-crypto/modules/_nacl_sign_.md index 67968fbb9..45d50a314 100644 --- a/docs/util-crypto/modules/_nacl_sign_.md +++ b/docs/util-crypto/modules/_nacl_sign_.md @@ -8,12 +8,10 @@ ▸ **naclSign**(message: *`Uint8Array`*, __namedParameters: *`object`*): `Uint8Array` -*Defined in [nacl/sign.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/sign.ts#L25)* +*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/sign.ts#L24)* *__name__*: naclSign -*__signature__*: naclSign (message: Uint8Array, secretKey: Uint8Array): Uint8Array - *__summary__*: Signs a message using the supplied secretKey *__description__*: Returns message signature of `message`, using the `secretKey`. diff --git a/docs/util-crypto/modules/_nacl_verify_.md b/docs/util-crypto/modules/_nacl_verify_.md index 06fbe065b..bc5e95893 100644 --- a/docs/util-crypto/modules/_nacl_verify_.md +++ b/docs/util-crypto/modules/_nacl_verify_.md @@ -8,12 +8,10 @@ ▸ **naclVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean` -*Defined in [nacl/verify.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/nacl/verify.ts#L22)* +*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/nacl/verify.ts#L21)* *__name__*: naclSign -*__signature__*: naclVerify (message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean - *__summary__*: Verifies the signature on the supplied message. *__description__*: Verifies the `signature` on `message` with the supplied `plublicKey`. Returns `true` on sucess, `false` otherwise. diff --git a/docs/util-crypto/modules/_random_ashex_.md b/docs/util-crypto/modules/_random_ashex_.md index 51cea9e0d..2dc22e261 100644 --- a/docs/util-crypto/modules/_random_ashex_.md +++ b/docs/util-crypto/modules/_random_ashex_.md @@ -8,12 +8,10 @@ ▸ **randomAsHex**(length?: *`number`*): `string` -*Defined in [random/asHex.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/random/asHex.ts#L24)* +*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/random/asHex.ts#L23)* *__name__*: randomAsHex -*__signature__*: randomAsHex (length?: number = 32): string - *__summary__*: Creates a hex string filled with random bytes. *__description__*: Returns a hex string with the specified (optional) length filled with random bytes. diff --git a/docs/util-crypto/modules/_random_ashex_spec_.md b/docs/util-crypto/modules/_random_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_random_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_random_asnumber_.md b/docs/util-crypto/modules/_random_asnumber_.md index 27c6f9990..5358f79d6 100644 --- a/docs/util-crypto/modules/_random_asnumber_.md +++ b/docs/util-crypto/modules/_random_asnumber_.md @@ -8,12 +8,10 @@ ▸ **randomAsNumber**(): `number` -*Defined in [random/asNumber.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/random/asNumber.ts#L27)* +*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/random/asNumber.ts#L26)* *__name__*: randomAsNumber -*__signature__*: randomAsNumber (): number - *__summary__*: Creates a random number from random bytes. *__description__*: Returns a random number generated from the secure bytes. diff --git a/docs/util-crypto/modules/_random_asnumber_spec_.md b/docs/util-crypto/modules/_random_asnumber_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_random_asnumber_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_random_asu8a_.md b/docs/util-crypto/modules/_random_asu8a_.md index e5fef2e41..346f2fc9e 100644 --- a/docs/util-crypto/modules/_random_asu8a_.md +++ b/docs/util-crypto/modules/_random_asu8a_.md @@ -8,12 +8,10 @@ ▸ **randomAsU8a**(length?: *`number`*): `Uint8Array` -*Defined in [random/asU8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/random/asU8a.ts#L22)* +*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/random/asU8a.ts#L21)* *__name__*: randomAsU8a -*__signature__*: randomAsU8a (length?: number = 32): Uint8Array - *__summary__*: Creates a Uint8Array filled with random bytes. *__description__*: Returns a `Uint8Array` with the specified (optional) length filled with random bytes. diff --git a/docs/util-crypto/modules/_random_asu8a_spec_.md b/docs/util-crypto/modules/_random_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_random_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromrandom_.md b/docs/util-crypto/modules/_schnorrkel_keypair_fromrandom_.md index 8cc43c3c8..01fb7c797 100644 --- a/docs/util-crypto/modules/_schnorrkel_keypair_fromrandom_.md +++ b/docs/util-crypto/modules/_schnorrkel_keypair_fromrandom_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelKeypairFromRandom**(): [KeypairType](_types_.md#keypairtype) -*Defined in [schnorrkel/keypair/fromRandom.ts:14](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/schnorrkel/keypair/fromRandom.ts#L14)* +*Defined in [schnorrkel/keypair/fromRandom.ts:14](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/schnorrkel/keypair/fromRandom.ts#L14)* *__name__*: schnorrkelKeypairFromRandom diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md index 1f433dfa2..cff457625 100644 --- a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md +++ b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* +*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* *__name__*: schnorrkelKeypairFromSeed diff --git a/docs/util-crypto/modules/_schnorrkel_sign_.md b/docs/util-crypto/modules/_schnorrkel_sign_.md index 9aff7e117..764826798 100644 --- a/docs/util-crypto/modules/_schnorrkel_sign_.md +++ b/docs/util-crypto/modules/_schnorrkel_sign_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelSign**(message: *`Uint8Array`*, __namedParameters: *`object`*): `Uint8Array` -*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/schnorrkel/sign.ts#L15)* +*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/schnorrkel/sign.ts#L15)* *__name__*: schnorrkelSign diff --git a/docs/util-crypto/modules/_schnorrkel_verify_.md b/docs/util-crypto/modules/_schnorrkel_verify_.md index 6449ab678..d1287c591 100644 --- a/docs/util-crypto/modules/_schnorrkel_verify_.md +++ b/docs/util-crypto/modules/_schnorrkel_verify_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean` -*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/schnorrkel/verify.ts#L11)* +*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/schnorrkel/verify.ts#L11)* *__name__*: schnorrkelVerify diff --git a/docs/util-crypto/modules/_sha512_asu8a_.md b/docs/util-crypto/modules/_sha512_asu8a_.md index 9526e243e..7c80ed1ea 100644 --- a/docs/util-crypto/modules/_sha512_asu8a_.md +++ b/docs/util-crypto/modules/_sha512_asu8a_.md @@ -8,12 +8,10 @@ ▸ **sha512AsU8a**(data: *`Uint8Array`*): `Uint8Array` -*Defined in [sha512/asU8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/sha512/asU8a.ts#L22)* +*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/sha512/asU8a.ts#L21)* *__name__*: sha512AsU8a -*__signature__*: sha512AsU8a (data: Uint8Array): Uint8Array - *__summary__*: Creates sha-512 hash of the input. *__description__*: Returns a sha-512 `Uint8Array` from the supplied data. diff --git a/docs/util-crypto/modules/_sha512_asu8a_spec_.md b/docs/util-crypto/modules/_sha512_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_sha512_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_types_.md b/docs/util-crypto/modules/_types_.md index 1e4d0d477..07c11aa2b 100644 --- a/docs/util-crypto/modules/_types_.md +++ b/docs/util-crypto/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ KeypairType**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/types.ts#L5)* #### Type declaration diff --git a/docs/util-crypto/modules/_xxhash_ashex_.md b/docs/util-crypto/modules/_xxhash_ashex_.md index f0de9f432..2746bf279 100644 --- a/docs/util-crypto/modules/_xxhash_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_ashex_.md @@ -8,12 +8,10 @@ ▸ **xxhashAsHex**(data: *`Buffer` | `Uint8Array` | `string`*, bitLength?: *`number`*): `string` -*Defined in [xxhash/asHex.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/asHex.ts#L24)* +*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/asHex.ts#L23)* *__name__*: xxhashAsHex -*__signature__*: xxhashAsHex (data: Buffer | Uint8Array | string, bitLength: number = 64): string - *__summary__*: Creates a xxhash64 hex from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a hex string with the specified `bitLength`. diff --git a/docs/util-crypto/modules/_xxhash_ashex_spec_.md b/docs/util-crypto/modules/_xxhash_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_xxhash_asu8a_.md b/docs/util-crypto/modules/_xxhash_asu8a_.md index cbb907a6d..eac003a49 100644 --- a/docs/util-crypto/modules/_xxhash_asu8a_.md +++ b/docs/util-crypto/modules/_xxhash_asu8a_.md @@ -8,12 +8,10 @@ ▸ **xxhashAsU8a**(data: *`Buffer` | `Uint8Array` | `string`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [xxhash/asU8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/asU8a.ts#L22)* +*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/asU8a.ts#L21)* *__name__*: xxhashAsU8a -*__signature__*: xxhashAsU8a (data: Buffer | Uint8Array | string, bitLength: number = 64): Uint8Array - *__summary__*: Creates a xxhash64 u8a from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a `Uint8Array` with the specified `bitLength`. diff --git a/docs/util-crypto/modules/_xxhash_asu8a_spec_.md b/docs/util-crypto/modules/_xxhash_asu8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_asu8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md index a8bd0cc99..ae2c8f61f 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md @@ -8,12 +8,10 @@ ▸ **xxhash64AsBn**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `BN` -*Defined in [xxhash/xxhash64/asBn.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L24)* +*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* *__name__*: xxhash64AsBn -*__signature__*: xxhash64AsBn (data: Buffer | Uint8Array | string, seed: number): BN - *__summary__*: Creates a xxhash BN from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a BN. diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_spec_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md index 8c9b68050..3f92c3e6a 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md @@ -8,12 +8,10 @@ ▸ **xxhash64AsHex**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asHex.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L24)* +*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* *__name__*: xxhash64AsHex -*__signature__*: xxhash64AsHex (data: Buffer | Uint8Array | string, seed: number): string - *__summary__*: Creates a xxhash hex from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex string. diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_spec_.md b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md index d857546a2..2a5b712dc 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md @@ -8,12 +8,10 @@ ▸ **xxhash64AsRaw**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asRaw.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L22)* +*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* *__name__*: xxhash64AsRaw -*__signature__*: xxhash64AsRaw (data: Buffer | Uint8Array | string, seed: number): string - *__summary__*: Creates a xxhash non-prefixed hex from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a non-prefixed hex string. diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_spec_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md index 8bf4844e2..945ff3b6a 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md @@ -8,12 +8,10 @@ ▸ **xxhash64AsValue**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `number` -*Defined in [xxhash/xxhash64/asValue.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L23)* +*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* *__name__*: xxhash64AsValue -*__signature__*: xxhash64AsValue (data: Buffer | Uint8Array | string, seed: number): number - *__summary__*: Creates a hex number from the input. *__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex number diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_spec_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/SUMMARY.md b/docs/util-rlp/SUMMARY.md index d2b42b2da..5971473c2 100644 --- a/docs/util-rlp/SUMMARY.md +++ b/docs/util-rlp/SUMMARY.md @@ -1,18 +1,23 @@ * ["decode"](modules/_decode_.md) +* ["decode.spec"](modules/_decode_spec_.md) * ["decoder/decode"](modules/_decoder_decode_.md) * ["decoder/index"](modules/_decoder_index_.md) * ["decoder/listLong"](modules/_decoder_listlong_.md) * ["decoder/listShort"](modules/_decoder_listshort_.md) * ["decoder/number"](modules/_decoder_number_.md) * ["decoder/safeParseInt"](modules/_decoder_safeparseint_.md) +* ["decoder/safeParseInt.spec"](modules/_decoder_safeparseint_spec_.md) * ["decoder/single"](modules/_decoder_single_.md) * ["decoder/string"](modules/_decoder_string_.md) * ["decoder/types"](modules/_decoder_types_.md) * ["encode"](modules/_encode_.md) +* ["encode.spec"](modules/_encode_spec_.md) * ["encoder/array"](modules/_encoder_array_.md) * ["encoder/index"](modules/_encoder_index_.md) * ["encoder/length"](modules/_encoder_length_.md) +* ["encoder/length.spec"](modules/_encoder_length_spec_.md) * ["encoder/toU8a"](modules/_encoder_tou8a_.md) +* ["encoder/toU8a.spec"](modules/_encoder_tou8a_spec_.md) * ["encoder/types"](modules/_encoder_types_.md) * ["encoder/u8a"](modules/_encoder_u8a_.md) * ["index"](modules/_index_.md) diff --git a/docs/util-rlp/modules/_decode_spec_.md b/docs/util-rlp/modules/_decode_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-rlp/modules/_decode_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/modules/_decoder_decode_.md b/docs/util-rlp/modules/_decoder_decode_.md index 7d5cc5c1e..61c984a21 100644 --- a/docs/util-rlp/modules/_decoder_decode_.md +++ b/docs/util-rlp/modules/_decoder_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/decode.ts#L28)* +*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/decode.ts#L28)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_index_.md b/docs/util-rlp/modules/_decoder_index_.md index 13483ad3a..434b406a5 100644 --- a/docs/util-rlp/modules/_decoder_index_.md +++ b/docs/util-rlp/modules/_decoder_index_.md @@ -8,12 +8,10 @@ ▸ **decoder**(input?: *`null` | `Uint8Array`*): `Uint8Array` | `Array`<`any`> -*Defined in [decoder/index.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/index.ts#L24)* +*Defined in [decoder/index.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/index.ts#L23)* *__name__*: decoder -*__signature__*: decoder (input?: Uint8Array): Uint8Array | Array<\*> - *__summary__*: Decodes the input RLP. *__description__*: From an input, decode the RLP and return the result as a `Uint8Array` or `Array`. diff --git a/docs/util-rlp/modules/_decoder_listlong_.md b/docs/util-rlp/modules/_decoder_listlong_.md index 19eb1a6bb..47835d75e 100644 --- a/docs/util-rlp/modules/_decoder_listlong_.md +++ b/docs/util-rlp/modules/_decoder_listlong_.md @@ -8,7 +8,7 @@ ▸ **decodeListLong**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/listLong.ts#L11)* +*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/listLong.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_listshort_.md b/docs/util-rlp/modules/_decoder_listshort_.md index 786bb183d..bdd76cce4 100644 --- a/docs/util-rlp/modules/_decoder_listshort_.md +++ b/docs/util-rlp/modules/_decoder_listshort_.md @@ -8,7 +8,7 @@ ▸ **decodeListShort**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/listShort.ts#L7)* +*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/listShort.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_number_.md b/docs/util-rlp/modules/_decoder_number_.md index 60bae9877..69256ebe1 100644 --- a/docs/util-rlp/modules/_decoder_number_.md +++ b/docs/util-rlp/modules/_decoder_number_.md @@ -8,7 +8,7 @@ ▸ **decodeNumber**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/number.ts#L11)* +*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/number.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_safeparseint_.md b/docs/util-rlp/modules/_decoder_safeparseint_.md index 6aefe43d7..b18c862a9 100644 --- a/docs/util-rlp/modules/_decoder_safeparseint_.md +++ b/docs/util-rlp/modules/_decoder_safeparseint_.md @@ -8,7 +8,7 @@ ▸ **safeParseInt**(input: *`Uint8Array`*): `number` -*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* +*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_safeparseint_spec_.md b/docs/util-rlp/modules/_decoder_safeparseint_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-rlp/modules/_decoder_safeparseint_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/modules/_decoder_single_.md b/docs/util-rlp/modules/_decoder_single_.md index f963b144b..ecc206d3f 100644 --- a/docs/util-rlp/modules/_decoder_single_.md +++ b/docs/util-rlp/modules/_decoder_single_.md @@ -8,7 +8,7 @@ ▸ **decodeSingle**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/single.ts#L7)* +*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/single.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_string_.md b/docs/util-rlp/modules/_decoder_string_.md index a925b70c4..9c7d04330 100644 --- a/docs/util-rlp/modules/_decoder_string_.md +++ b/docs/util-rlp/modules/_decoder_string_.md @@ -8,7 +8,7 @@ ▸ **decodeString**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/string.ts#L9)* +*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/string.ts#L9)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_types_.md b/docs/util-rlp/modules/_decoder_types_.md index eb87a5e07..4dd18a382 100644 --- a/docs/util-rlp/modules/_decoder_types_.md +++ b/docs/util-rlp/modules/_decoder_types_.md @@ -8,7 +8,7 @@ **Ƭ DecodeFunc**: *`function`* -*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/types.ts#L10)* +*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/types.ts#L10)* #### Type declaration ▸(input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) @@ -28,7 +28,7 @@ ___ **Ƭ DecodeOutput**: *`object`* -*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/decoder/types.ts#L5)* +*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/decoder/types.ts#L5)* #### Type declaration diff --git a/docs/util-rlp/modules/_encode_spec_.md b/docs/util-rlp/modules/_encode_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-rlp/modules/_encode_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/modules/_encoder_array_.md b/docs/util-rlp/modules/_encoder_array_.md index bf592ef17..9d1f83225 100644 --- a/docs/util-rlp/modules/_encoder_array_.md +++ b/docs/util-rlp/modules/_encoder_array_.md @@ -8,7 +8,7 @@ ▸ **encodeArray**(encoder: *[EncodeFunc](_encoder_types_.md#encodefunc)*, input: *`any`*): `Uint8Array` -*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/array.ts#L11)* +*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/array.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_index_.md b/docs/util-rlp/modules/_encoder_index_.md index 83e87ceff..ddeaf0cf4 100644 --- a/docs/util-rlp/modules/_encoder_index_.md +++ b/docs/util-rlp/modules/_encoder_index_.md @@ -8,12 +8,10 @@ ▸ **encoder**(input: *`any`*): `Uint8Array` -*Defined in [encoder/index.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/index.ts#L24)* +*Defined in [encoder/index.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/index.ts#L23)* *__name__*: encoder -*__signature__*: encoder (input: any): Uint8Array - *__summary__*: Encodes the input value into RLP. *__description__*: From an input, calculate the RLP and return the result as a `Uint8Array`. diff --git a/docs/util-rlp/modules/_encoder_length_.md b/docs/util-rlp/modules/_encoder_length_.md index 61985e466..c0d8197fd 100644 --- a/docs/util-rlp/modules/_encoder_length_.md +++ b/docs/util-rlp/modules/_encoder_length_.md @@ -8,7 +8,7 @@ ▸ **encodeLength**(length: *`number`*, offset: *`number`*): `Uint8Array` -*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/length.ts#L7)* +*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/length.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_length_spec_.md b/docs/util-rlp/modules/_encoder_length_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-rlp/modules/_encoder_length_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/modules/_encoder_tou8a_.md b/docs/util-rlp/modules/_encoder_tou8a_.md index 0a1e38be5..08b554156 100644 --- a/docs/util-rlp/modules/_encoder_tou8a_.md +++ b/docs/util-rlp/modules/_encoder_tou8a_.md @@ -6,15 +6,15 @@ ## toU8a -▸ **toU8a**(value: *`any`*): `Uint8Array` +▸ **toU8a**(value?: *`any`*): `Uint8Array` -*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/toU8a.ts#L39)* +*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/toU8a.ts#L39)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `any` | +| `Optional` value | `any` | **Returns:** `Uint8Array` diff --git a/docs/util-rlp/modules/_encoder_tou8a_spec_.md b/docs/util-rlp/modules/_encoder_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util-rlp/modules/_encoder_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util-rlp/modules/_encoder_types_.md b/docs/util-rlp/modules/_encoder_types_.md index 87ba8207d..7d4969b92 100644 --- a/docs/util-rlp/modules/_encoder_types_.md +++ b/docs/util-rlp/modules/_encoder_types_.md @@ -8,7 +8,7 @@ **Ƭ EncodeFunc**: *`function`* -*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/types.ts#L5)* +*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/types.ts#L5)* #### Type declaration ▸(input: *`any`*): `Uint8Array` diff --git a/docs/util-rlp/modules/_encoder_u8a_.md b/docs/util-rlp/modules/_encoder_u8a_.md index 0b5bbcbe7..d8dd9f9d3 100644 --- a/docs/util-rlp/modules/_encoder_u8a_.md +++ b/docs/util-rlp/modules/_encoder_u8a_.md @@ -8,7 +8,7 @@ ▸ **encodeU8a**(encoder: *[EncodeFunc](_encoder_types_.md#encodefunc)*, input: *`Uint8Array`*): `Uint8Array` -*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util-rlp/src/encoder/u8a.ts#L11)* +*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util-rlp/src/encoder/u8a.ts#L11)* **Parameters:** diff --git a/docs/util/SUMMARY.md b/docs/util/SUMMARY.md index c877c0681..f07161267 100644 --- a/docs/util/SUMMARY.md +++ b/docs/util/SUMMARY.md @@ -1,15 +1,20 @@ * ["array/filter"](modules/_array_filter_.md) +* ["array/filter.spec"](modules/_array_filter_spec_.md) * ["array/index"](modules/_array_index_.md) * ["assert"](modules/_assert_.md) +* ["assert.spec"](modules/_assert_spec_.md) * ["bn/fromHex"](modules/_bn_fromhex_.md) +* ["bn/fromHex.spec"](modules/_bn_fromhex_spec_.md) * ["bn/index"](modules/_bn_index_.md) * ["bn/toBn"](modules/_bn_tobn_.md) +* ["bn/toBn.spec"](modules/_bn_tobn_spec_.md) * ["bn/toHex"](modules/_bn_tohex_.md) * ["bn/toHex.spec"](modules/_bn_tohex_spec_.md) * ["bn/toU8a"](modules/_bn_tou8a_.md) * ["bn/toU8a.spec"](modules/_bn_tou8a_spec_.md) * ["buffer/index"](modules/_buffer_index_.md) * ["buffer/toU8a"](modules/_buffer_tou8a_.md) +* ["buffer/toU8a.spec"](modules/_buffer_tou8a_spec_.md) * ["compact/addLength"](modules/_compact_addlength_.md) * ["compact/addLength.spec"](modules/_compact_addlength_spec_.md) * ["compact/defaults"](modules/_compact_defaults_.md) @@ -23,37 +28,63 @@ * ["compact/types"](modules/_compact_types_.md) * ["ext/error"](modules/_ext_error_.md) * [ExtError](classes/_ext_error_.exterror.md) +* ["ext/error.spec"](modules/_ext_error_spec_.md) * ["ext/index"](modules/_ext_index_.md) * ["hex/addPrefix"](modules/_hex_addprefix_.md) +* ["hex/addPrefix.spec"](modules/_hex_addprefix_spec_.md) * ["hex/fixLength"](modules/_hex_fixlength_.md) +* ["hex/fixLength.spec"](modules/_hex_fixlength_spec_.md) * ["hex/hasPrefix"](modules/_hex_hasprefix_.md) +* ["hex/hasPrefix.spec"](modules/_hex_hasprefix_spec_.md) * ["hex/index"](modules/_hex_index_.md) * ["hex/stripPrefix"](modules/_hex_stripprefix_.md) +* ["hex/stripPrefix.spec"](modules/_hex_stripprefix_spec_.md) * ["hex/toBn"](modules/_hex_tobn_.md) * ["hex/toBn.spec"](modules/_hex_tobn_spec_.md) * ["hex/toNumber"](modules/_hex_tonumber_.md) +* ["hex/toNumber.spec"](modules/_hex_tonumber_spec_.md) * ["hex/toU8a"](modules/_hex_tou8a_.md) +* ["hex/toU8a.spec"](modules/_hex_tou8a_spec_.md) * ["index"](modules/_index_.md) +* ["index.spec"](modules/_index_spec_.md) * ["is/bn"](modules/_is_bn_.md) +* ["is/bn.spec"](modules/_is_bn_spec_.md) * ["is/boolean"](modules/_is_boolean_.md) +* ["is/boolean.spec"](modules/_is_boolean_spec_.md) * ["is/buffer"](modules/_is_buffer_.md) +* ["is/buffer.spec"](modules/_is_buffer_spec_.md) * ["is/error"](modules/_is_error_.md) +* ["is/error.spec"](modules/_is_error_spec_.md) * ["is/function"](modules/_is_function_.md) +* ["is/function.spec"](modules/_is_function_spec_.md) * ["is/hex"](modules/_is_hex_.md) +* ["is/hex.spec"](modules/_is_hex_spec_.md) * ["is/index"](modules/_is_index_.md) * ["is/instanceOf"](modules/_is_instanceof_.md) +* ["is/instanceOf.spec"](modules/_is_instanceof_spec_.md) * ["is/ip"](modules/_is_ip_.md) +* ["is/ip.spec"](modules/_is_ip_spec_.md) * ["is/null"](modules/_is_null_.md) +* ["is/null.spec"](modules/_is_null_spec_.md) * ["is/number"](modules/_is_number_.md) +* ["is/number.spec"](modules/_is_number_spec_.md) * ["is/object"](modules/_is_object_.md) +* ["is/object.spec"](modules/_is_object_spec_.md) * ["is/observable"](modules/_is_observable_.md) +* ["is/observable.spec"](modules/_is_observable_spec_.md) * ["is/string"](modules/_is_string_.md) +* ["is/string.spec"](modules/_is_string_spec_.md) * ["is/u8a"](modules/_is_u8a_.md) +* ["is/u8a.spec"](modules/_is_u8a_spec_.md) * ["is/undefined"](modules/_is_undefined_.md) +* ["is/undefined.spec"](modules/_is_undefined_spec_.md) * ["logger"](modules/_logger_.md) +* ["logger.spec"](modules/_logger_spec_.md) * ["number/index"](modules/_number_index_.md) * ["number/toHex"](modules/_number_tohex_.md) +* ["number/toHex.spec"](modules/_number_tohex_spec_.md) * ["number/toU8a"](modules/_number_tou8a_.md) +* ["number/toU8a.spec"](modules/_number_tou8a_spec_.md) * ["polyfill/fill"](modules/_polyfill_fill_.md) * ["polyfill/fill.spec"](modules/_polyfill_fill_spec_.md) * ["polyfill/index"](modules/_polyfill_index_.md) @@ -63,24 +94,39 @@ * ["polyfill/padStart.spec"](modules/_polyfill_padstart_spec_.md) * ["polyfill/setPrototypeOf"](modules/_polyfill_setprototypeof_.md) * ["polyfill/textDecoder"](modules/_polyfill_textdecoder_.md) +* ["polyfill/textDecoder.spec"](modules/_polyfill_textdecoder_spec_.md) * ["polyfill/textEncoder"](modules/_polyfill_textencoder_.md) +* ["polyfill/textEncoder.spec"](modules/_polyfill_textencoder_spec_.md) * ["promisify"](modules/_promisify_.md) +* ["promisify.spec"](modules/_promisify_spec_.md) * ["string/camelCase"](modules/_string_camelcase_.md) +* ["string/camelCase.spec"](modules/_string_camelcase_spec_.md) * ["string/index"](modules/_string_index_.md) * ["string/lowerFirst"](modules/_string_lowerfirst_.md) +* ["string/lowerFirst.spec"](modules/_string_lowerfirst_spec_.md) * ["string/shorten"](modules/_string_shorten_.md) +* ["string/shorten.spec"](modules/_string_shorten_spec_.md) * ["string/toU8a"](modules/_string_tou8a_.md) +* ["string/toU8a.spec"](modules/_string_tou8a_spec_.md) * ["string/upperFirst"](modules/_string_upperfirst_.md) +* ["string/upperFirst.spec"](modules/_string_upperfirst_spec_.md) * ["syncify"](modules/_syncify_.md) +* ["syncify.spec"](modules/_syncify_spec_.md) * ["types"](modules/_types_.md) * [ExtErrorInterface](interfaces/_types_.exterrorinterface.md) * [ToBnOptions](interfaces/_types_.tobnoptions.md) * ["u8a/concat"](modules/_u8a_concat_.md) +* ["u8a/concat.spec"](modules/_u8a_concat_spec_.md) * ["u8a/fixLength"](modules/_u8a_fixlength_.md) +* ["u8a/fixLength.spec"](modules/_u8a_fixlength_spec_.md) * ["u8a/index"](modules/_u8a_index_.md) * ["u8a/toBn"](modules/_u8a_tobn_.md) * ["u8a/toBn.spec"](modules/_u8a_tobn_spec_.md) * ["u8a/toBuffer"](modules/_u8a_tobuffer_.md) +* ["u8a/toBuffer.spec"](modules/_u8a_tobuffer_spec_.md) * ["u8a/toHex"](modules/_u8a_tohex_.md) +* ["u8a/toHex.spec"](modules/_u8a_tohex_spec_.md) * ["u8a/toString"](modules/_u8a_tostring_.md) +* ["u8a/toString.spec"](modules/_u8a_tostring_spec_.md) * ["u8a/toU8a"](modules/_u8a_tou8a_.md) +* ["u8a/toU8a.spec"](modules/_u8a_tou8a_spec_.md) diff --git a/docs/util/classes/_ext_error_.exterror.md b/docs/util/classes/_ext_error_.exterror.md index 89830ae1e..d16604ef8 100644 --- a/docs/util/classes/_ext_error_.exterror.md +++ b/docs/util/classes/_ext_error_.exterror.md @@ -2,8 +2,6 @@ *__name__*: ExtError -*__signature__*: ExtError (message: string = '', code: number = UNKNOWN\_ERROR, value: any) - *__summary__*: Extension to the basic JS Error. *__description__*: The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal `stack`, `message`, the numeric `code` and `data` (any types) parameters are available on the object. @@ -34,7 +32,7 @@ throw new ExtError('some message', ExtError.CODES.METHOD_NOT_FOUND); // => error ⊕ **new ExtError**(message?: *`string`*, code?: *`number`*, data?: *`any`*): [ExtError](_ext_error_.exterror.md) -*Defined in [ext/error.ts:44](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L44)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L43)* **Parameters:** @@ -58,7 +56,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[code](../interfaces/_types_.exterrorinterface.md#code)* -*Defined in [ext/error.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L36)* +*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L35)* ___ @@ -69,7 +67,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[data](../interfaces/_types_.exterrorinterface.md#data)* -*Defined in [ext/error.ts:38](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L38)* +*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L37)* ___ @@ -82,7 +80,7 @@ ___ *Overrides Error.message* -*Defined in [ext/error.ts:40](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L40)* +*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L39)* ___ @@ -93,7 +91,7 @@ ___ *Overrides Error.name* -*Defined in [ext/error.ts:42](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L42)* +*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L41)* ___ @@ -106,7 +104,7 @@ ___ *Overrides Error.stack* -*Defined in [ext/error.ts:44](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L44)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L43)* ___ @@ -127,7 +125,7 @@ ___ **CODES**: *`object`* -*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L61)* +*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L60)* @@ -135,7 +133,7 @@ ___ **● ASSERT**: *`number`* = -90009 -*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L62)* +*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L61)* ___ @@ -144,7 +142,7 @@ ___ **● INVALID_JSONRPC**: *`number`* = -99998 -*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L64)* +*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L63)* ___ @@ -153,7 +151,7 @@ ___ **● METHOD_NOT_FOUND**: *`number`* = -32601 -*Defined in [ext/error.ts:65](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L65)* +*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L64)* ___ @@ -162,7 +160,7 @@ ___ **● UNKNOWN**: *`number`* -*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/ext/error.ts#L63)* +*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/ext/error.ts#L62)* ___ diff --git a/docs/util/index.html b/docs/util/index.html index 283a12c00..56fdc8df3 100644 --- a/docs/util/index.html +++ b/docs/util/index.html @@ -416,7 +416,7 @@ diff --git a/docs/util/interfaces/_types_.exterrorinterface.md b/docs/util/interfaces/_types_.exterrorinterface.md index 3614aecb0..84a31d656 100644 --- a/docs/util/interfaces/_types_.exterrorinterface.md +++ b/docs/util/interfaces/_types_.exterrorinterface.md @@ -16,7 +16,7 @@ **● code**: *`number`* -*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L6)* ___ @@ -25,7 +25,7 @@ ___ **● data**: *`any`* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L7)* ___ @@ -34,7 +34,7 @@ ___ **● message**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L8)* ___ @@ -43,7 +43,7 @@ ___ **● stack**: *`string`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L9)* ___ diff --git a/docs/util/interfaces/_types_.tobnoptions.md b/docs/util/interfaces/_types_.tobnoptions.md index 40dd510e6..bf94a62e4 100644 --- a/docs/util/interfaces/_types_.tobnoptions.md +++ b/docs/util/interfaces/_types_.tobnoptions.md @@ -12,7 +12,7 @@ **● isLe**: *`undefined` | `false` | `true`* -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L24)* ___ @@ -21,7 +21,7 @@ ___ **● isNegative**: *`undefined` | `false` | `true`* -*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L25)* ___ diff --git a/docs/util/modules/_array_filter_.md b/docs/util/modules/_array_filter_.md index 427b70f09..48fa65776 100644 --- a/docs/util/modules/_array_filter_.md +++ b/docs/util/modules/_array_filter_.md @@ -8,12 +8,10 @@ ▸ **arrayFilter**(array: *`Array`<`any`>*, allowNulls?: *`boolean`*): `Array`<`any`> -*Defined in [array/filter.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/array/filter.ts#L24)* +*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/array/filter.ts#L23)* *__name__*: arrayFilter -*__signature__*: arrayFilter (array: Array, allowNulls: boolean = true): Array - *__summary__*: Filters undefined and (optionally) null values from an array *__description__*: Returns a new array with all `undefined` values removed. Optionally, when `allowNulls = false`, it removes the `null` values as well diff --git a/docs/util/modules/_array_filter_spec_.md b/docs/util/modules/_array_filter_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_array_filter_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_assert_.md b/docs/util/modules/_assert_.md index 4202f6c65..3f13801f0 100644 --- a/docs/util/modules/_assert_.md +++ b/docs/util/modules/_assert_.md @@ -6,14 +6,12 @@ ## assert -▸ **assert**(test: *`any`*, message: *`string` | `MessageFn`*, code?: *`number`*, data?: *`any`*): `boolean` +▸ **assert**<`T`>(test: *`Falsy` | `T`*, message: *`string` | `MessageFn`*, code?: *`number`*, data?: *`any`*): `boolean` -*Defined in [assert.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/assert.ts#L27)* +*Defined in [assert.ts:28](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/assert.ts#L28)* *__name__*: assert -*__signature__*: assert (test: any, message: string | () => string, code: number = ExtError.CODES.ASSERT, data: any): void - *__summary__*: Checks for a valid test, if not ExtError is thrown. *__description__*: Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an ExtError with the supplied `message` and an optional `code` and `data`. When `test` passes, `true` is returned. @@ -28,11 +26,14 @@ assert(false, 'False should not be true'); // ExtError thrown assert(false, () => 'message'); // ExtError with 'message' ``` +**Type parameters:** + +#### T **Parameters:** | Name | Type | Default value | | ------ | ------ | ------ | -| test | `any` | - | +| test | `Falsy` | `T` | - | | message | `string` | `MessageFn` | - | | `Default value` code | `number` | ExtError.CODES.ASSERT | | `Optional` data | `any` | - | diff --git a/docs/util/modules/_assert_spec_.md b/docs/util/modules/_assert_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_assert_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_bn_fromhex_spec_.md b/docs/util/modules/_bn_fromhex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_bn_fromhex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_bn_tobn_.md b/docs/util/modules/_bn_tobn_.md index 0bc48877b..9cbcdda94 100644 --- a/docs/util/modules/_bn_tobn_.md +++ b/docs/util/modules/_bn_tobn_.md @@ -8,12 +8,10 @@ ▸ **bnToBn**(value?: *`BN` | `number` | `null`*): `BN` -*Defined in [bn/toBn.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/bn/toBn.ts#L24)* +*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/bn/toBn.ts#L23)* *__name__*: bnToBn -*__signature__*: bnToBn (value?: BN : number): BN - *__summary__*: Creates a BN value from a BN.js bignumber or number input. *__description__*: `null` inputs returns a `0x0` result, BN values returns the value, numnbers returns a BN representation. diff --git a/docs/util/modules/_bn_tobn_spec_.md b/docs/util/modules/_bn_tobn_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_bn_tobn_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_bn_tohex_.md b/docs/util/modules/_bn_tohex_.md index 87f5c1a57..5e85ca259 100644 --- a/docs/util/modules/_bn_tohex_.md +++ b/docs/util/modules/_bn_tohex_.md @@ -8,12 +8,10 @@ ▸ **bnToHex**(value?: *`BN` | `number` | `null`*, options?: *`number` | `Options`*): `string` -*Defined in [bn/toHex.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/bn/toHex.ts#L34)* +*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/bn/toHex.ts#L33)* *__name__*: bnToHex -*__signature__*: bnToHex (value?: BN, bitLength: number = -1): string - *__summary__*: Creates a hex value from a BN.js bignumber object. *__description__*: `null` inputs returns a `0x` result, BN values return the actual value as a `0x` prefixed hex value. Anything that is not a BN object throws an error. With `bitLength` set, it fixes the number to the specified length. diff --git a/docs/util/modules/_bn_tou8a_.md b/docs/util/modules/_bn_tou8a_.md index e3e996e06..b04277020 100644 --- a/docs/util/modules/_bn_tou8a_.md +++ b/docs/util/modules/_bn_tou8a_.md @@ -10,12 +10,10 @@ ▸ **bnToU8a**(value: *`BN` | `number` | `null`*, bitLength?: *`undefined` | `number`*, isLe?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/bn/toU8a.ts#L30)* +*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/bn/toU8a.ts#L29)* *__name__*: bnToU8a -*__signature__*: bnToU8a (value?: BN | number, bitLength: number = -1, isLE: boolean = false): Uint8Array - *__summary__*: Creates a Uint8Array object from a BN. *__description__*: `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `BN` input values return the actual bytes value converted to a `Uint8Array`. Optionally convert using little-endian format if `isLE` is set. @@ -37,7 +35,7 @@ bnToU8a(new BN(0x1234)); // => [0x12, 0x34] **Returns:** `Uint8Array` -*Defined in [bn/toU8a.ts:31](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/bn/toU8a.ts#L31)* +*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/bn/toU8a.ts#L30)* **Parameters:** diff --git a/docs/util/modules/_buffer_tou8a_.md b/docs/util/modules/_buffer_tou8a_.md index 5f7d2fd4e..bdd9be123 100644 --- a/docs/util/modules/_buffer_tou8a_.md +++ b/docs/util/modules/_buffer_tou8a_.md @@ -6,14 +6,12 @@ ## bufferToU8a -▸ **bufferToU8a**(buffer?: *`Buffer` | `number`[]*): `Uint8Array` +▸ **bufferToU8a**(buffer?: *`Buffer` | `number`[] | `null`*): `Uint8Array` -*Defined in [buffer/toU8a.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/buffer/toU8a.ts#L20)* +*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/buffer/toU8a.ts#L19)* *__name__*: bufferToU8a -*__signature__*: bufferToU8a (value?: Buffer): string - *__summary__*: Creates a Uint8Array value from a Buffer object. *__description__*: `null` inputs returns an empty result, `Buffer` values return the actual value as a `Uint8Array`. Anything that is not a `Buffer` object throws an error. @@ -30,7 +28,7 @@ bufferToU8a(Buffer.from([1, 2, 3])); | Name | Type | | ------ | ------ | -| `Optional` buffer | `Buffer` | `number`[] | +| `Optional` buffer | `Buffer` | `number`[] | `null` | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_buffer_tou8a_spec_.md b/docs/util/modules/_buffer_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_buffer_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_compact_addlength_.md b/docs/util/modules/_compact_addlength_.md index d3d3bdf1b..dec56b1d5 100644 --- a/docs/util/modules/_compact_addlength_.md +++ b/docs/util/modules/_compact_addlength_.md @@ -8,7 +8,7 @@ ▸ **compactAddLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/addLength.ts#L20)* +*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/addLength.ts#L20)* *__name__*: compactAddLength diff --git a/docs/util/modules/_compact_defaults_.md b/docs/util/modules/_compact_defaults_.md index 134890e52..be318550c 100644 --- a/docs/util/modules/_compact_defaults_.md +++ b/docs/util/modules/_compact_defaults_.md @@ -8,7 +8,7 @@ **● DEFAULT_BITLENGTH**: *[BitLength](_compact_types_.md#bitlength)* = 32 -*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/defaults.ts#L7)* +*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/defaults.ts#L7)* ___ diff --git a/docs/util/modules/_compact_fromu8a_.md b/docs/util/modules/_compact_fromu8a_.md index 72e04a3cd..77e7fc1d3 100644 --- a/docs/util/modules/_compact_fromu8a_.md +++ b/docs/util/modules/_compact_fromu8a_.md @@ -8,7 +8,7 @@ ▸ **compactFromU8a**(_input: *`Uint8Array` | `string`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `BN`] -*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/fromU8a.ts#L26)* +*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/fromU8a.ts#L26)* *__name__*: compactFromU8a diff --git a/docs/util/modules/_compact_striplength_.md b/docs/util/modules/_compact_striplength_.md index ae78ec573..1376a027a 100644 --- a/docs/util/modules/_compact_striplength_.md +++ b/docs/util/modules/_compact_striplength_.md @@ -8,7 +8,7 @@ ▸ **compactStripLength**(input: *`Uint8Array`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `Uint8Array`] -*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/stripLength.ts#L22)* +*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/stripLength.ts#L22)* *__name__*: compactStripLength diff --git a/docs/util/modules/_compact_tou8a_.md b/docs/util/modules/_compact_tou8a_.md index ce76a0ff5..2f401239e 100644 --- a/docs/util/modules/_compact_tou8a_.md +++ b/docs/util/modules/_compact_tou8a_.md @@ -8,7 +8,7 @@ ▸ **compactToU8a**(_value: *`BN` | `number`*): `Uint8Array` -*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/toU8a.ts#L27)* +*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/toU8a.ts#L27)* *__name__*: compactToU8a diff --git a/docs/util/modules/_compact_types_.md b/docs/util/modules/_compact_types_.md index 1a95ebcbe..731fee2f9 100644 --- a/docs/util/modules/_compact_types_.md +++ b/docs/util/modules/_compact_types_.md @@ -8,7 +8,7 @@ **Ƭ BitLength**: *`8` | `16` | `32` | `64` | `128` | `256`* -*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/compact/types.ts#L5)* +*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/compact/types.ts#L5)* ___ diff --git a/docs/util/modules/_ext_error_spec_.md b/docs/util/modules/_ext_error_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_ext_error_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_addprefix_.md b/docs/util/modules/_hex_addprefix_.md index 11370771c..e962514ae 100644 --- a/docs/util/modules/_hex_addprefix_.md +++ b/docs/util/modules/_hex_addprefix_.md @@ -6,14 +6,12 @@ ## hexAddPrefix -▸ **hexAddPrefix**(value: *`string` | `null` | `undefined`*): `string` +▸ **hexAddPrefix**(value?: *`string` | `null`*): `string` -*Defined in [hex/addPrefix.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/addPrefix.ts#L22)* +*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/addPrefix.ts#L21)* *__name__*: hexAddPrefix -*__signature__*: hexAddPrefix (value: ?string): string - *__summary__*: Adds the `0x` prefix to string values. *__description__*: Returns a `0x` prefixed string from the input value. If the input is already prefixed, it is returned unchanged. @@ -30,7 +28,7 @@ console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12 | Name | Type | | ------ | ------ | -| value | `string` | `null` | `undefined` | +| `Optional` value | `string` | `null` | **Returns:** `string` diff --git a/docs/util/modules/_hex_addprefix_spec_.md b/docs/util/modules/_hex_addprefix_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_addprefix_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_fixlength_.md b/docs/util/modules/_hex_fixlength_.md index aa27e8b5c..6e9069bdc 100644 --- a/docs/util/modules/_hex_fixlength_.md +++ b/docs/util/modules/_hex_fixlength_.md @@ -8,12 +8,10 @@ ▸ **hexFixLength**(value: *`string`*, bitLength?: *`number`*, withPadding?: *`boolean`*): `string` -*Defined in [hex/fixLength.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/fixLength.ts#L25)* +*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/fixLength.ts#L24)* *__name__*: hexFixLength -*__signature__*: hexFixLength (value: string, bitLength: number = -1, withPadding: boolean = false): string - *__summary__*: Shifts a hex string to a specific bitLength *__description__*: Returns a `0x` prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When `withPadding` is set, shorter values are padded with `0`. diff --git a/docs/util/modules/_hex_fixlength_spec_.md b/docs/util/modules/_hex_fixlength_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_fixlength_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_hasprefix_.md b/docs/util/modules/_hex_hasprefix_.md index af8b85d03..e21296469 100644 --- a/docs/util/modules/_hex_hasprefix_.md +++ b/docs/util/modules/_hex_hasprefix_.md @@ -6,14 +6,12 @@ ## hexHasPrefix -▸ **hexHasPrefix**(value: *`string` | `null` | `undefined`*): `boolean` +▸ **hexHasPrefix**(value?: *`string` | `null`*): `boolean` -*Defined in [hex/hasPrefix.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/hasPrefix.ts#L22)* +*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/hasPrefix.ts#L21)* *__name__*: hexHasPrefix -*__signature__*: hexHasPrefix (value: ?string): boolean - *__summary__*: Tests for the existence of a `0x` prefix. *__description__*: Checks for a valid hex input value and if the start matched `0x` @@ -30,7 +28,7 @@ console.log('has prefix', hexHasPrefix('0x1234')); // => true | Name | Type | | ------ | ------ | -| value | `string` | `null` | `undefined` | +| `Optional` value | `string` | `null` | **Returns:** `boolean` diff --git a/docs/util/modules/_hex_hasprefix_spec_.md b/docs/util/modules/_hex_hasprefix_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_hasprefix_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_stripprefix_.md b/docs/util/modules/_hex_stripprefix_.md index 32cae978b..a797a80e3 100644 --- a/docs/util/modules/_hex_stripprefix_.md +++ b/docs/util/modules/_hex_stripprefix_.md @@ -6,14 +6,12 @@ ## hexStripPrefix -▸ **hexStripPrefix**(value: *`string` | `null` | `undefined`*): `string` +▸ **hexStripPrefix**(value?: *`string` | `null`*): `string` -*Defined in [hex/stripPrefix.ts:24](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/stripPrefix.ts#L24)* +*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/stripPrefix.ts#L23)* *__name__*: hexStripPrefix -*__signature__*: hexStripPrefix (value: ?string): string - *__summary__*: Strips any leading `0x` prefix. *__description__*: Tests for the existence of a `0x` prefix, and returns the value without the prefix. Un-prefixed values are returned as-is. @@ -30,7 +28,7 @@ console.log('stripped', hexStripPrefix('0x1234')); // => 1234 | Name | Type | | ------ | ------ | -| value | `string` | `null` | `undefined` | +| `Optional` value | `string` | `null` | **Returns:** `string` diff --git a/docs/util/modules/_hex_stripprefix_spec_.md b/docs/util/modules/_hex_stripprefix_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_stripprefix_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_tobn_.md b/docs/util/modules/_hex_tobn_.md index 17a878276..b6d4997ab 100644 --- a/docs/util/modules/_hex_tobn_.md +++ b/docs/util/modules/_hex_tobn_.md @@ -8,12 +8,10 @@ ▸ **hexToBn**(value?: *`string` | `number` | `null`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean`*): `BN` -*Defined in [hex/toBn.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/toBn.ts#L36)* +*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/toBn.ts#L35)* *__name__*: hexToBn -*__signature__*: hexToBn (value?: string, \_options: ToBnOptions | boolean = { isLe: false, isNegative: false }): BN - *__summary__*: Creates a BN.js bignumber object from a hex string. *__description__*: `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error. diff --git a/docs/util/modules/_hex_tonumber_.md b/docs/util/modules/_hex_tonumber_.md index 2744112dc..a298f9235 100644 --- a/docs/util/modules/_hex_tonumber_.md +++ b/docs/util/modules/_hex_tonumber_.md @@ -6,14 +6,12 @@ ## hexToNumber -▸ **hexToNumber**(value?: *`undefined` | `string`*): `number` +▸ **hexToNumber**(value?: *`string` | `null`*): `number` -*Defined in [hex/toNumber.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/toNumber.ts#L22)* +*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/toNumber.ts#L21)* *__name__*: hexToNumber -*__signature__*: hexToNumber (value?: string): number - *__summary__*: Creates a Number value from a Buffer object. *__description__*: `null` inputs returns an NaN result, `hex` values return the actual value as a `Number`. @@ -30,7 +28,7 @@ hexToNumber('0x1234'); // => 0x1234 | Name | Type | | ------ | ------ | -| `Optional` value | `undefined` | `string` | +| `Optional` value | `string` | `null` | **Returns:** `number` diff --git a/docs/util/modules/_hex_tonumber_spec_.md b/docs/util/modules/_hex_tonumber_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_tonumber_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_hex_tou8a_.md b/docs/util/modules/_hex_tou8a_.md index 0ccfcc477..89ed4ec09 100644 --- a/docs/util/modules/_hex_tou8a_.md +++ b/docs/util/modules/_hex_tou8a_.md @@ -8,12 +8,10 @@ ▸ **hexToU8a**(_value?: *`string` | `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [hex/toU8a.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/hex/toU8a.ts#L25)* +*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/hex/toU8a.ts#L24)* *__name__*: hexToU8a -*__signature__*: hexToU8a (value?: string, bitLength: number = -1): Uint8Array - *__summary__*: Creates a Buffer object from a hex string. *__description__*: `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error. diff --git a/docs/util/modules/_hex_tou8a_spec_.md b/docs/util/modules/_hex_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_hex_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_index_spec_.md b/docs/util/modules/_index_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_index_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_bn_.md b/docs/util/modules/_is_bn_.md index 2acc7927e..8e2a4bf9d 100644 --- a/docs/util/modules/_is_bn_.md +++ b/docs/util/modules/_is_bn_.md @@ -8,12 +8,10 @@ ▸ **isBn**(value: *`any`*): `boolean` -*Defined in [is/bn.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/bn.ts#L23)* +*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/bn.ts#L22)* *__name__*: isBn -*__signature__*: isBN (value: any): boolean - *__summary__*: Tests for a `BN` object instance. *__description__*: Checks to see if the input object is an instance of `BN` (bn.js). diff --git a/docs/util/modules/_is_bn_spec_.md b/docs/util/modules/_is_bn_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_bn_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_boolean_.md b/docs/util/modules/_is_boolean_.md index fbf15b3b0..6b09320db 100644 --- a/docs/util/modules/_is_boolean_.md +++ b/docs/util/modules/_is_boolean_.md @@ -8,12 +8,10 @@ ▸ **isBoolean**(value: *`any`*): `boolean` -*Defined in [is/boolean.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/boolean.ts#L20)* +*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/boolean.ts#L19)* *__name__*: isBoolean -*__signature__*: isBoolean (value: any): boolean - *__summary__*: Tests for a boolean value. *__description__*: Checks to see if the input value is a JavaScript boolean. diff --git a/docs/util/modules/_is_boolean_spec_.md b/docs/util/modules/_is_boolean_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_boolean_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_buffer_.md b/docs/util/modules/_is_buffer_.md index e523bb819..2139d9b66 100644 --- a/docs/util/modules/_is_buffer_.md +++ b/docs/util/modules/_is_buffer_.md @@ -8,12 +8,10 @@ ▸ **isBuffer**(value: *`any`*): `boolean` -*Defined in [is/buffer.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/buffer.ts#L22)* +*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/buffer.ts#L21)* *__name__*: isBuffer -*__signature__*: isBuffer (value: any): boolean - *__summary__*: Tests for a `Buffer` object instance. *__description__*: Checks to see if the input object is an instance of `Buffer`. diff --git a/docs/util/modules/_is_buffer_spec_.md b/docs/util/modules/_is_buffer_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_buffer_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_error_.md b/docs/util/modules/_is_error_.md index 7fccedf62..4e77d76c5 100644 --- a/docs/util/modules/_is_error_.md +++ b/docs/util/modules/_is_error_.md @@ -8,12 +8,10 @@ ▸ **isError**(value: *`any`*): `boolean` -*Defined in [is/error.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/error.ts#L22)* +*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/error.ts#L21)* *__name__*: isError -*__signature__*: isError (value: any): boolean - *__summary__*: Tests for a `Error` object instance. *__description__*: Checks to see if the input object is an instance of `Error`. diff --git a/docs/util/modules/_is_error_spec_.md b/docs/util/modules/_is_error_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_error_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_function_.md b/docs/util/modules/_is_function_.md index 7d5f4fccd..d23312e5e 100644 --- a/docs/util/modules/_is_function_.md +++ b/docs/util/modules/_is_function_.md @@ -8,12 +8,10 @@ ▸ **isFunction**(value: *`any`*): `boolean` -*Defined in [is/function.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/function.ts#L20)* +*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/function.ts#L19)* *__name__*: isFunction -*__signature__*: isFunction (value: any): boolean - *__summary__*: Tests for a `function`. *__description__*: Checks to see if the input value is a JavaScript function. diff --git a/docs/util/modules/_is_function_spec_.md b/docs/util/modules/_is_function_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_function_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_hex_.md b/docs/util/modules/_is_hex_.md index 1ff67d6a3..5028b25f8 100644 --- a/docs/util/modules/_is_hex_.md +++ b/docs/util/modules/_is_hex_.md @@ -8,12 +8,10 @@ ▸ **isHex**(value: *`any`*, bitLength?: *`number`*, ignoreLength?: *`boolean`*): `boolean` -*Defined in [is/hex.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/hex.ts#L25)* +*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/hex.ts#L24)* *__name__*: isHex -*__signature__*: isHex (value: any, bitLength: number = -1): boolean - *__summary__*: Tests for a hex string. *__description__*: Checks to see if the input value is a `0x` prefixed hex string. Optionally (`bitLength` !== -1) checks to see if the bitLength is correct. diff --git a/docs/util/modules/_is_hex_spec_.md b/docs/util/modules/_is_hex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_hex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_instanceof_.md b/docs/util/modules/_is_instanceof_.md index 024b9c239..7d163b071 100644 --- a/docs/util/modules/_is_instanceof_.md +++ b/docs/util/modules/_is_instanceof_.md @@ -8,12 +8,10 @@ ▸ **isInstanceOf**(value: *`any`*, clazz: *`any`*): `boolean` -*Defined in [is/instanceOf.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/instanceOf.ts#L20)* +*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/instanceOf.ts#L19)* *__name__*: isInstanceOf -*__signature__*: isInstanceOf (value: any, clazz: Class): boolean - *__summary__*: Tests for a instance of a class. *__description__*: Checks to see if the input value is an instance of the test class. diff --git a/docs/util/modules/_is_instanceof_spec_.md b/docs/util/modules/_is_instanceof_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_instanceof_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_ip_.md b/docs/util/modules/_is_ip_.md index ed4e5777a..4a15ca06e 100644 --- a/docs/util/modules/_is_ip_.md +++ b/docs/util/modules/_is_ip_.md @@ -8,12 +8,10 @@ ▸ **isIp**(value: *`string`*, type?: *`IpTypes`*): `boolean` -*Defined in [is/ip.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/ip.ts#L27)* +*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/ip.ts#L26)* *__name__*: isIp -*__signature__*: isIp (value: string, type?: 'v4' | 'v6'): boolean - *__summary__*: Tests if the value is a valid IP address *__description__*: Checks to see if the value is a valid IP address. Optionally check for either v4/v6 diff --git a/docs/util/modules/_is_ip_spec_.md b/docs/util/modules/_is_ip_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_ip_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_null_.md b/docs/util/modules/_is_null_.md index a961eefea..e52d4bad2 100644 --- a/docs/util/modules/_is_null_.md +++ b/docs/util/modules/_is_null_.md @@ -6,14 +6,12 @@ ## isNull -▸ **isNull**(value: *`any`*): `boolean` +▸ **isNull**(value?: *`any`*): `boolean` -*Defined in [is/null.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/null.ts#L20)* +*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/null.ts#L19)* *__name__*: isNull -*__signature__*: isNull (value: any): boolean - *__summary__*: Tests for a `null` values. *__description__*: Checks to see if the input value is `null`. @@ -30,7 +28,7 @@ console.log('isNull', isNull(null)); // => true | Name | Type | | ------ | ------ | -| value | `any` | +| `Optional` value | `any` | **Returns:** `boolean` diff --git a/docs/util/modules/_is_null_spec_.md b/docs/util/modules/_is_null_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_null_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_number_.md b/docs/util/modules/_is_number_.md index b28ffcad8..113053b1f 100644 --- a/docs/util/modules/_is_number_.md +++ b/docs/util/modules/_is_number_.md @@ -8,12 +8,10 @@ ▸ **isNumber**(value: *`any`*): `boolean` -*Defined in [is/number.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/number.ts#L20)* +*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/number.ts#L19)* *__name__*: isNumber -*__signature__*: isNumber (value: any): boolean - *__summary__*: Tests for a JavaScript number. *__description__*: Checks to see if the input value is a valid number. diff --git a/docs/util/modules/_is_number_spec_.md b/docs/util/modules/_is_number_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_number_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_object_.md b/docs/util/modules/_is_object_.md index 84b027671..a2d874004 100644 --- a/docs/util/modules/_is_object_.md +++ b/docs/util/modules/_is_object_.md @@ -8,12 +8,10 @@ ▸ **isObject**(value: *`any`*): `boolean` -*Defined in [is/object.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/object.ts#L25)* +*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/object.ts#L24)* *__name__*: isObject -*__signature__*: isObject (value: any): boolean - *__summary__*: Tests for an `object`. *__description__*: Checks to see if the input value is a JavaScript object. diff --git a/docs/util/modules/_is_object_spec_.md b/docs/util/modules/_is_object_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_object_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_observable_.md b/docs/util/modules/_is_observable_.md index b920269f6..1b3998437 100644 --- a/docs/util/modules/_is_observable_.md +++ b/docs/util/modules/_is_observable_.md @@ -8,12 +8,10 @@ ▸ **isObservable**(value: *`any`*): `boolean` -*Defined in [is/observable.ts:27](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/observable.ts#L27)* +*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/observable.ts#L26)* *__name__*: isBObservable -*__signature__*: isObservable (value: any): boolean - *__summary__*: Tests for a `Observable` object instance. *__description__*: Checks to see if the input object is an instance of `BN` (bn.js). diff --git a/docs/util/modules/_is_observable_spec_.md b/docs/util/modules/_is_observable_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_observable_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_string_.md b/docs/util/modules/_is_string_.md index c9e436ab1..7439c697e 100644 --- a/docs/util/modules/_is_string_.md +++ b/docs/util/modules/_is_string_.md @@ -8,12 +8,10 @@ ▸ **isString**(value: *`any`*): `boolean` -*Defined in [is/string.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/string.ts#L20)* +*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/string.ts#L19)* *__name__*: isString -*__signature__*: isString (value: any): boolean - *__summary__*: Tests for a string. *__description__*: Checks to see if the input value is a JavaScript string. diff --git a/docs/util/modules/_is_string_spec_.md b/docs/util/modules/_is_string_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_string_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_u8a_.md b/docs/util/modules/_is_u8a_.md index a11897440..08bdc003d 100644 --- a/docs/util/modules/_is_u8a_.md +++ b/docs/util/modules/_is_u8a_.md @@ -6,14 +6,12 @@ ## isU8a -▸ **isU8a**(value: *`any`*): `boolean` +▸ **isU8a**(value?: *`any`*): `boolean` -*Defined in [is/u8a.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/u8a.ts#L22)* +*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/u8a.ts#L21)* *__name__*: isU8a -*__signature__*: isU8a (value: any): boolean - *__summary__*: Tests for a `Uint8Array` object instance. *__description__*: Checks to see if the input object is an instance of `Uint8Array`. @@ -30,7 +28,7 @@ console.log('isU8a', isU8a([])); // => false | Name | Type | | ------ | ------ | -| value | `any` | +| `Optional` value | `any` | **Returns:** `boolean` diff --git a/docs/util/modules/_is_u8a_spec_.md b/docs/util/modules/_is_u8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_u8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_is_undefined_.md b/docs/util/modules/_is_undefined_.md index 405360171..eb4c3413e 100644 --- a/docs/util/modules/_is_undefined_.md +++ b/docs/util/modules/_is_undefined_.md @@ -6,14 +6,12 @@ ## isUndefined -▸ **isUndefined**(value: *`any`*): `boolean` +▸ **isUndefined**(value?: *`any`*): `boolean` -*Defined in [is/undefined.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/is/undefined.ts#L20)* +*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/is/undefined.ts#L19)* *__name__*: isUndefined -*__signature__*: isUndefined (value: any): boolean - *__summary__*: Tests for a `undefined` values. *__description__*: Checks to see if the input value is `undefined`. @@ -30,7 +28,7 @@ console.log('isUndefined', isUndefined(void(0))); // => true | Name | Type | | ------ | ------ | -| value | `any` | +| `Optional` value | `any` | **Returns:** `boolean` diff --git a/docs/util/modules/_is_undefined_spec_.md b/docs/util/modules/_is_undefined_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_is_undefined_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_logger_.md b/docs/util/modules/_logger_.md index 7829b8e44..bb093df9b 100644 --- a/docs/util/modules/_logger_.md +++ b/docs/util/modules/_logger_.md @@ -8,7 +8,7 @@ ▸ **format**(value: *`any`*): `any` -*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/logger.ts#L42)* +*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/logger.ts#L42)* **Parameters:** @@ -25,12 +25,10 @@ ___ ▸ **logger**(_type: *`string`*): [Logger](_types_.md#logger) -*Defined in [logger.ts:105](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/logger.ts#L105)* +*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/logger.ts#L104)* *__name__*: Logger -*__signature__*: logger (type: string): Logger - *__summary__*: Creates a consistent log interface for messages *__description__*: Returns a `Logger` that has `.log`, `.error`, `.warn` and `.debug` (controlled with environment `DEBUG=typeA,typeB`) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console. diff --git a/docs/util/modules/_logger_spec_.md b/docs/util/modules/_logger_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_logger_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_number_tohex_.md b/docs/util/modules/_number_tohex_.md index a4571d511..abfc6516c 100644 --- a/docs/util/modules/_number_tohex_.md +++ b/docs/util/modules/_number_tohex_.md @@ -6,14 +6,12 @@ ## numberToHex -▸ **numberToHex**(value?: *`undefined` | `number`*, bitLength?: *`number`*): `string` +▸ **numberToHex**(value?: *`number` | `null`*, bitLength?: *`number`*): `string` -*Defined in [number/toHex.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/number/toHex.ts#L25)* +*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/number/toHex.ts#L24)* *__name__*: numberToHex -*__signature__*: numberToHex (value?: number): string - *__summary__*: Creates a hex value from a number. *__description__*: `null`/`undefined`/`NaN` inputs returns an empty `0x` result. `number` input values return the actual bytes value converted to a `hex`. With `bitLength` set, it converts the number to the equivalent size. @@ -31,7 +29,7 @@ numberToHex(0x1234, 32); // => 0x00001234 | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `undefined` | `number` | - | +| `Optional` value | `number` | `null` | - | | `Default value` bitLength | `number` | -1 | **Returns:** `string` diff --git a/docs/util/modules/_number_tohex_spec_.md b/docs/util/modules/_number_tohex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_number_tohex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_number_tou8a_.md b/docs/util/modules/_number_tou8a_.md index 2d258e3ef..94806231f 100644 --- a/docs/util/modules/_number_tou8a_.md +++ b/docs/util/modules/_number_tou8a_.md @@ -6,14 +6,12 @@ ## numberToU8a -▸ **numberToU8a**(value?: *`undefined` | `number`*, bitLength?: *`number`*): `Uint8Array` +▸ **numberToU8a**(value?: *`number` | `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [number/toU8a.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/number/toU8a.ts#L23)* +*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/number/toU8a.ts#L22)* *__name__*: numberToU8a -*__signature__*: numberToU8a (value?: number, bitLenght: number = -1): Uint8Array - *__summary__*: Creates a Uint8Array object from a number. *__description__*: `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `number` input values return the actual bytes value converted to a `Uint8Array`. With `bitLength`, it converts the value to the equivalent size. @@ -30,7 +28,7 @@ numberToU8a(0x1234); // => [0x12, 0x34] | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `undefined` | `number` | - | +| `Optional` value | `number` | `null` | - | | `Default value` bitLength | `number` | -1 | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_number_tou8a_spec_.md b/docs/util/modules/_number_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_number_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_polyfill_textdecoder_spec_.md b/docs/util/modules/_polyfill_textdecoder_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_polyfill_textdecoder_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_polyfill_textencoder_spec_.md b/docs/util/modules/_polyfill_textencoder_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_polyfill_textencoder_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_promisify_.md b/docs/util/modules/_promisify_.md index fe754b513..3190fe257 100644 --- a/docs/util/modules/_promisify_.md +++ b/docs/util/modules/_promisify_.md @@ -8,12 +8,10 @@ ▸ **promisify**(self: *`any`*, fn: *`Function`*, ...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [promisify.ts:21](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/promisify.ts#L21)* +*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/promisify.ts#L20)* *__name__*: promisify -*__signature__*: function promisify (this: ?Object, fn: Function, ...params: Array): Promise - *__summary__*: Wraps an async callback into a `Promise` *__description__*: Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value. diff --git a/docs/util/modules/_promisify_spec_.md b/docs/util/modules/_promisify_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_promisify_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_string_camelcase_spec_.md b/docs/util/modules/_string_camelcase_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_string_camelcase_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_string_lowerfirst_.md b/docs/util/modules/_string_lowerfirst_.md index cd4a1ddef..06fc82e99 100644 --- a/docs/util/modules/_string_lowerfirst_.md +++ b/docs/util/modules/_string_lowerfirst_.md @@ -6,14 +6,12 @@ ## stringLowerFirst -▸ **stringLowerFirst**(_value: *`string`*): `string` +▸ **stringLowerFirst**(value?: *`string` | `null`*): `string` -*Defined in [string/lowerFirst.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/string/lowerFirst.ts#L23)* +*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/string/lowerFirst.ts#L19)* *__name__*: stringLowerFirst -*__signature__*: stringLowerFirst (\_value: string): string - *__summary__*: Lowercase the first letter of a string *__description__*: Lowercase the first letter of a string @@ -30,7 +28,7 @@ stringLowerFirst('ABC'); // => 'aBC' | Name | Type | | ------ | ------ | -| _value | `string` | +| `Optional` value | `string` | `null` | **Returns:** `string` diff --git a/docs/util/modules/_string_lowerfirst_spec_.md b/docs/util/modules/_string_lowerfirst_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_string_lowerfirst_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_string_shorten_.md b/docs/util/modules/_string_shorten_.md index 604cd5ace..be9e8b50b 100644 --- a/docs/util/modules/_string_shorten_.md +++ b/docs/util/modules/_string_shorten_.md @@ -6,14 +6,12 @@ ## stringShorten -▸ **stringShorten**(_value: *`any`*, prefixLength?: *`number`*): `string` +▸ **stringShorten**(_value?: *`any`*, prefixLength?: *`number`*): `string` -*Defined in [string/shorten.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/string/shorten.ts#L20)* +*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/string/shorten.ts#L19)* *__name__*: stringShorten -*__signature__*: stringShorten (value: any, prefixLength: number = 8): string - *__summary__*: Returns a string with maximum length *__description__*: Checks the string against the `prefixLength`, if longer than dopuble this, shortens it by placing `..` in the middle of it @@ -30,7 +28,7 @@ stringShorten('1234567890', 2); // => 12..90 | Name | Type | Default value | | ------ | ------ | ------ | -| _value | `any` | - | +| `Optional` _value | `any` | - | | `Default value` prefixLength | `number` | 6 | **Returns:** `string` diff --git a/docs/util/modules/_string_shorten_spec_.md b/docs/util/modules/_string_shorten_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_string_shorten_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_string_tou8a_.md b/docs/util/modules/_string_tou8a_.md index 4d94cbe65..03e66024c 100644 --- a/docs/util/modules/_string_tou8a_.md +++ b/docs/util/modules/_string_tou8a_.md @@ -8,12 +8,10 @@ ▸ **stringToU8a**(value?: *`undefined` | `string`*): `Uint8Array` -*Defined in [string/toU8a.ts:40](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/string/toU8a.ts#L40)* +*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/string/toU8a.ts#L39)* *__name__*: stringToU8a -*__signature__*: stringToU8a (value?: string): UInt8Array - *__summary__*: Creates a Uint8Array object from a utf-8 string. *__description__*: String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array. diff --git a/docs/util/modules/_string_tou8a_spec_.md b/docs/util/modules/_string_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_string_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_string_upperfirst_.md b/docs/util/modules/_string_upperfirst_.md index 6095d88af..546cbb15d 100644 --- a/docs/util/modules/_string_upperfirst_.md +++ b/docs/util/modules/_string_upperfirst_.md @@ -6,14 +6,12 @@ ## stringUpperFirst -▸ **stringUpperFirst**(_value: *`string`*): `string` +▸ **stringUpperFirst**(value?: *`string` | `null`*): `string` -*Defined in [string/upperFirst.ts:23](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/string/upperFirst.ts#L23)* +*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/string/upperFirst.ts#L19)* *__name__*: stringUpperFirst -*__signature__*: stringUpperFirst (\_value: string): string - *__summary__*: Lowercase the first letter of a string *__description__*: Lowercase the first letter of a string @@ -30,7 +28,7 @@ stringUpperFirst('abc'); // => 'Abc' | Name | Type | | ------ | ------ | -| _value | `string` | +| `Optional` value | `string` | `null` | **Returns:** `string` diff --git a/docs/util/modules/_string_upperfirst_spec_.md b/docs/util/modules/_string_upperfirst_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_string_upperfirst_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_syncify_.md b/docs/util/modules/_syncify_.md index 20ef27120..680d84214 100644 --- a/docs/util/modules/_syncify_.md +++ b/docs/util/modules/_syncify_.md @@ -8,7 +8,7 @@ ▸ **syncify**(promise: *`Promise`<`any`>*): `any` -*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/syncify.ts#L11)* +*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/syncify.ts#L11)* **Parameters:** diff --git a/docs/util/modules/_syncify_spec_.md b/docs/util/modules/_syncify_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_syncify_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_types_.md b/docs/util/modules/_types_.md index d3bf82f56..508c81444 100644 --- a/docs/util/modules/_types_.md +++ b/docs/util/modules/_types_.md @@ -22,7 +22,7 @@ **Ƭ Logger**: *`object`* -*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L15)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ Logger$Data**: *`Array`<`any` | `Logger$Data$Fn`>* -*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/types.ts#L13)* ___ diff --git a/docs/util/modules/_u8a_concat_.md b/docs/util/modules/_u8a_concat_.md index 401446b82..8708512a0 100644 --- a/docs/util/modules/_u8a_concat_.md +++ b/docs/util/modules/_u8a_concat_.md @@ -8,12 +8,10 @@ ▸ **u8aConcat**(..._list: *`Array`<`Uint8Array` | `string`>*): `Uint8Array` -*Defined in [u8a/concat.ts:25](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/concat.ts#L25)* +*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/concat.ts#L24)* *__name__*: u8aConcat -*__signature__*: u8aConcat (...values: Array): Uint8Array - *__summary__*: Creates a concatenated Uint8Array from the inputs. *__description__*: Concatenates the input arrays into a single `UInt8Array`. diff --git a/docs/util/modules/_u8a_concat_spec_.md b/docs/util/modules/_u8a_concat_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_concat_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_u8a_fixlength_.md b/docs/util/modules/_u8a_fixlength_.md index 0fc9c4f8e..6616796d7 100644 --- a/docs/util/modules/_u8a_fixlength_.md +++ b/docs/util/modules/_u8a_fixlength_.md @@ -8,12 +8,10 @@ ▸ **u8aFixLength**(value: *`Uint8Array`*, bitLength?: *`number`*, atStart?: *`boolean`*): `Uint8Array` -*Defined in [u8a/fixLength.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/fixLength.ts#L22)* +*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/fixLength.ts#L21)* *__name__*: u8aFixLength -*__signature__*: u8aFixLength (value: string, bitLength: number = -1, withPadding: boolean = false): string - *__summary__*: Shifts a Uint8Array to a specific bitLength *__description__*: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. diff --git a/docs/util/modules/_u8a_fixlength_spec_.md b/docs/util/modules/_u8a_fixlength_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_fixlength_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_u8a_tobn_.md b/docs/util/modules/_u8a_tobn_.md index 55bb5f131..aa62425e7 100644 --- a/docs/util/modules/_u8a_tobn_.md +++ b/docs/util/modules/_u8a_tobn_.md @@ -8,12 +8,10 @@ ▸ **u8aToBn**(value: *`Uint8Array`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean`*): `BN` -*Defined in [u8a/toBn.ts:30](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/toBn.ts#L30)* +*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/toBn.ts#L29)* *__name__*: u8aToBn -*__signature__*: u8aToHex (value?: Uint8Array, options: ToBnOptions | boolean = { isLe: true, isNegative: false }): BN - *__summary__*: Creates a BN from a Uint8Array object. *__description__*: `UInt8Array` input values return the actual BN. `null` or `undefined` values returns an `0x0` value. diff --git a/docs/util/modules/_u8a_tobuffer_.md b/docs/util/modules/_u8a_tobuffer_.md index 978811463..af6c2a2bf 100644 --- a/docs/util/modules/_u8a_tobuffer_.md +++ b/docs/util/modules/_u8a_tobuffer_.md @@ -6,14 +6,12 @@ ## u8aToBuffer -▸ **u8aToBuffer**(value?: *`Uint8Array`*): `Buffer` +▸ **u8aToBuffer**(value?: *`Uint8Array` | `null`*): `Buffer` -*Defined in [u8a/toBuffer.ts:20](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/toBuffer.ts#L20)* +*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/toBuffer.ts#L19)* *__name__*: u8aToBuffer -*__signature__*: u8aToBuffer (value?: UInt8Array): Buffer - *__summary__*: Creates a Buffer object from a hex string. *__description__*: `null` inputs returns an empty `Buffer` result. `UInt8Array` input values return the actual bytes value converted to a `Buffer`. Anything that is not a `UInt8Array` throws an error. @@ -30,7 +28,7 @@ console.log('Buffer', u8aToBuffer('0x123480001f')); | Name | Type | | ------ | ------ | -| `Optional` value | `Uint8Array` | +| `Optional` value | `Uint8Array` | `null` | **Returns:** `Buffer` diff --git a/docs/util/modules/_u8a_tobuffer_spec_.md b/docs/util/modules/_u8a_tobuffer_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_tobuffer_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_u8a_tohex_.md b/docs/util/modules/_u8a_tohex_.md index 8c3d223bd..84e2cf1c3 100644 --- a/docs/util/modules/_u8a_tohex_.md +++ b/docs/util/modules/_u8a_tohex_.md @@ -8,12 +8,10 @@ ▸ **u8aToHex**(value?: *`Uint8Array` | `null`*, bitLength?: *`number`*, isPrefixed?: *`boolean`*): `string` -*Defined in [u8a/toHex.ts:22](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/toHex.ts#L22)* +*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/toHex.ts#L21)* *__name__*: u8aToHex -*__signature__*: u8aToHex (value?: UInt8Array): string - *__summary__*: Creates a hex string from a Uint8Array object. *__description__*: `UInt8Array` input values return the actual hex string. `null` or `undefined` values returns an `0x` string. diff --git a/docs/util/modules/_u8a_tohex_spec_.md b/docs/util/modules/_u8a_tohex_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_tohex_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_u8a_tostring_.md b/docs/util/modules/_u8a_tostring_.md index 9e4fb57a4..3bba0ab48 100644 --- a/docs/util/modules/_u8a_tostring_.md +++ b/docs/util/modules/_u8a_tostring_.md @@ -6,14 +6,12 @@ ## u8aToString -▸ **u8aToString**(value?: *`Uint8Array`*): `string` +▸ **u8aToString**(value?: *`Uint8Array` | `null`*): `string` -*Defined in [u8a/toString.ts:36](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/toString.ts#L36)* +*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/toString.ts#L35)* *__name__*: u8aToString -*__signature__*: u8aToString (value?: UInt8Array): string - *__summary__*: Creates a utf-8 string from a Uint8Array object. *__description__*: `UInt8Array` input values return the actual decoded utf-8 string. `null` or `undefined` values returns an empty string. @@ -30,7 +28,7 @@ u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello | Name | Type | | ------ | ------ | -| `Optional` value | `Uint8Array` | +| `Optional` value | `Uint8Array` | `null` | **Returns:** `string` diff --git a/docs/util/modules/_u8a_tostring_spec_.md b/docs/util/modules/_u8a_tostring_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_tostring_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/util/modules/_u8a_tou8a_.md b/docs/util/modules/_u8a_tou8a_.md index f3fe67775..29de5e958 100644 --- a/docs/util/modules/_u8a_tou8a_.md +++ b/docs/util/modules/_u8a_tou8a_.md @@ -8,12 +8,10 @@ ▸ **u8aToU8a**(value?: *`Array`<`number`> | `Buffer` | `Uint8Array` | `string` | `null`*): `Uint8Array` -*Defined in [u8a/toU8a.ts:28](https://github.com/polkadot-js/common/blob/06cc692/packages/util/src/u8a/toU8a.ts#L28)* +*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/util/src/u8a/toU8a.ts#L27)* *__name__*: u8aToU8a -*__signature__*: u8aToU8a (value?: Array | Buffer | Uint8Array | string | null): Uint8Array - *__summary__*: Creates a Uint8Array value from a Uint8Array bignumber or hex input. *__description__*: `null` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation. diff --git a/docs/util/modules/_u8a_tou8a_spec_.md b/docs/util/modules/_u8a_tou8a_spec_.md new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/docs/util/modules/_u8a_tou8a_spec_.md @@ -0,0 +1,2 @@ + + diff --git a/lerna.json b/lerna.json index 6ac70df48..a10f9ff9a 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.34.3" + "version": "0.34.4" } diff --git a/package.json b/package.json index 4697f5dde..3cdc91bda 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.34.3", + "version": "0.34.4", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/chainspec/package.json b/packages/chainspec/package.json index 63538b693..7436eba48 100644 --- a/packages/chainspec/package.json +++ b/packages/chainspec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/chainspec", - "version": "0.34.3", + "version": "0.34.4", "description": "Contains chain specifications for known chains", "main": "index.js", "keywords": [ @@ -29,6 +29,6 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/chainspec#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3" + "@polkadot/util": "^0.34.4" } } diff --git a/packages/db/package.json b/packages/db/package.json index 31940cdcf..f7702a150 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/db", - "version": "0.34.3", + "version": "0.34.4", "description": "Implementation of a basic sync in-memory and on-disk databases with overlays", "main": "index.js", "keywords": [ @@ -29,8 +29,8 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/db#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/trie-hash": "^0.34.3", - "@polkadot/util": "^0.34.3", + "@polkadot/trie-hash": "^0.34.4", + "@polkadot/util": "^0.34.4", "@types/mkdirp": "^0.5.2", "@types/rimraf": "^2.0.2", "@types/snappy": "^6.0.0", diff --git a/packages/keyring/package.json b/packages/keyring/package.json index fde0ea32c..c2f6b2a78 100644 --- a/packages/keyring/package.json +++ b/packages/keyring/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/keyring", - "version": "0.34.3", + "version": "0.34.4", "description": "Keyring management", "main": "index.js", "engines": { @@ -31,8 +31,8 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3", - "@polkadot/util-crypto": "^0.34.3", + "@polkadot/util": "^0.34.4", + "@polkadot/util-crypto": "^0.34.4", "@types/bs58": "^4.0.0", "bs58": "^4.0.1" } diff --git a/packages/trie-codec/package.json b/packages/trie-codec/package.json index a54a32dcc..10374f076 100644 --- a/packages/trie-codec/package.json +++ b/packages/trie-codec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-codec", - "version": "0.34.3", + "version": "0.34.4", "description": "This is an implementation of the codec for Substrate Trie", "main": "index.js", "keywords": [ @@ -29,6 +29,6 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-codec#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3" + "@polkadot/util": "^0.34.4" } } diff --git a/packages/trie-db/package.json b/packages/trie-db/package.json index 3807930b6..8fb7bbde0 100644 --- a/packages/trie-db/package.json +++ b/packages/trie-db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-db", - "version": "0.34.3", + "version": "0.34.4", "description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper, adapted for Polkadot", "main": "index.js", "keywords": [ @@ -29,15 +29,15 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-db#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/db": "^0.34.3", - "@polkadot/trie-codec": "^0.34.3", - "@polkadot/trie-hash": "^0.34.3", - "@polkadot/util": "^0.34.3", - "@polkadot/util-crypto": "^0.34.3" + "@polkadot/db": "^0.34.4", + "@polkadot/trie-codec": "^0.34.4", + "@polkadot/trie-hash": "^0.34.4", + "@polkadot/util": "^0.34.4", + "@polkadot/util-crypto": "^0.34.4" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.3", - "@polkadot/util-rlp": "^0.34.3", + "@polkadot/chainspec": "^0.34.4", + "@polkadot/util-rlp": "^0.34.4", "ethereumjs-testing": "1.0.4" } } diff --git a/packages/trie-hash/package.json b/packages/trie-hash/package.json index f33c5f827..bbcc98f34 100644 --- a/packages/trie-hash/package.json +++ b/packages/trie-hash/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-hash", - "version": "0.34.3", + "version": "0.34.4", "description": "Generates trie roots from key-value pairs", "main": "index.js", "keywords": [ @@ -29,9 +29,9 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3" + "@polkadot/util": "^0.34.4" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.3" + "@polkadot/chainspec": "^0.34.4" } } diff --git a/packages/util-crypto/package.json b/packages/util-crypto/package.json index 3a1d3ebd8..d3cc7c6be 100644 --- a/packages/util-crypto/package.json +++ b/packages/util-crypto/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-crypto", - "version": "0.34.3", + "version": "0.34.4", "description": "A collection of useful crypto utilities for @polkadot", "main": "index.js", "keywords": [ @@ -29,7 +29,7 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3", + "@polkadot/util": "^0.34.4", "@types/bip39": "^2.4.1", "@types/webassembly-js-api": "^0.0.2", "bip39": "^2.5.0", diff --git a/packages/util-rlp/package.json b/packages/util-rlp/package.json index 1a20e7089..0ec55ccd0 100644 --- a/packages/util-rlp/package.json +++ b/packages/util-rlp/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-rlp", - "version": "0.34.3", + "version": "0.34.4", "description": "RLP encoding and decoding", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-rlp#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/util": "^0.34.3" + "@polkadot/util": "^0.34.4" }, "devDependencies": { "ethereumjs-testing": "1.0.4" diff --git a/packages/util/package.json b/packages/util/package.json index cdec53cd1..00c7f9213 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util", - "version": "0.34.3", + "version": "0.34.4", "description": "A collection of useful utilities for @polkadot", "main": "index.js", "keywords": [