From fcfc20fe9567bff9c32373608680b9e0c2d683fd Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Fri, 15 Feb 2019 13:40:51 +0000 Subject: [PATCH] [CI Skip] 0.34.13 --- docs/GLOSSARY.html | 2 +- docs/chainspec/modules/_types_.md | 2 +- docs/db/classes/_disk_.diskdb.md | 28 +++++----- .../_engines_filetreedb_.filetreedb.md | 28 +++++----- docs/db/classes/_engines_lrudb_.lrudb.md | 32 +++++------ .../db/classes/_engines_memorydb_.memorydb.md | 26 ++++----- .../_engines_transactiondb_.transactiondb.md | 28 +++++----- docs/db/classes/_fileflatdb_cache_.cache.md | 2 +- .../classes/_fileflatdb_compact_.compact.md | 4 +- docs/db/classes/_fileflatdb_file_.file.md | 2 +- docs/db/classes/_fileflatdb_impl_.impl.md | 2 +- .../classes/_fileflatdb_index_.fileflatdb.md | 26 ++++----- docs/db/classes/_memory_.memory.md | 28 +++++----- docs/db/enums/_fileflatdb_types_.slot.md | 6 +- docs/db/interfaces/_types_.basedb.md | 24 ++++---- docs/db/interfaces/_types_.txdb.md | 26 ++++----- docs/db/modules/_fileflatdb_types_.md | 6 +- docs/db/modules/_types_.md | 6 +- .../keyring/01_create_account/index.html | 2 +- .../keyring/02_load_accounts/index.html | 2 +- docs/examples/keyring/index.html | 2 +- .../index.html | 2 +- .../02_sign_verify_message_nacl/index.html | 2 +- .../index.html | 2 +- docs/examples/util-crypto/index.html | 2 +- docs/index.html | 2 +- docs/keyring/classes/_index_.keyring.md | 51 ++++++++--------- docs/keyring/classes/_pairs_.pairs.md | 18 +++--- docs/keyring/index.html | 2 +- .../interfaces/_types_.keyringinstance.md | 56 +++++++++---------- .../keyring/interfaces/_types_.keyringpair.md | 38 ++++++------- .../interfaces/_types_.keyringpairs.md | 16 +++--- docs/keyring/modules/_address_decode_.md | 6 +- docs/keyring/modules/_address_encode_.md | 6 +- docs/keyring/modules/_address_setprefix_.md | 2 +- docs/keyring/modules/_address_types_.md | 4 +- docs/keyring/modules/_pair_decode_.md | 8 +-- docs/keyring/modules/_pair_encode_.md | 6 +- docs/keyring/modules/_pair_index_.md | 6 +- docs/keyring/modules/_pair_nobody_.md | 2 +- docs/keyring/modules/_pair_tojson_.md | 2 +- docs/keyring/modules/_pair_types_.md | 2 +- docs/keyring/modules/_testing_.md | 2 +- docs/keyring/modules/_testingpairs_.md | 2 +- docs/keyring/modules/_types_.md | 16 +++--- .../classes/_nodeheader_.branchheader.md | 4 +- .../classes/_nodeheader_.extensionheader.md | 4 +- .../classes/_nodeheader_.leafheader.md | 4 +- .../classes/_nodeheader_.nibbleheader.md | 4 +- .../classes/_nodeheader_.nodeheader.md | 18 +++--- docs/trie-codec/modules/_constants_.md | 30 +++++----- docs/trie-codec/modules/_decode_.md | 8 +-- docs/trie-codec/modules/_encode_.md | 6 +- docs/trie-codec/modules/_nibbles_.md | 26 ++++----- .../modules/_stream_createbranch_.md | 6 +- .../modules/_stream_createempty_.md | 2 +- .../modules/_stream_createextension_.md | 2 +- .../trie-codec/modules/_stream_createleaf_.md | 2 +- .../modules/_stream_createsubstream_.md | 2 +- .../modules/_stream_createvalue_.md | 6 +- docs/trie-codec/modules/_stream_endbranch_.md | 6 +- docs/trie-codec/modules/_types_.md | 2 +- docs/trie-codec/modules/_util_fromnibbles_.md | 2 +- docs/trie-codec/modules/_util_fusenibbles_.md | 2 +- .../modules/_util_sharedprefixlength_.md | 2 +- docs/trie-codec/modules/_util_tonibbles_.md | 6 +- .../classes/_checkpoint_.checkpoint.md | 2 +- docs/trie-db/classes/_impl_.impl.md | 5 +- docs/trie-db/classes/_index_.trie.md | 39 ++++++------- docs/trie-db/enums/_types_.nodetype.md | 8 +-- docs/trie-db/index.html | 2 +- docs/trie-db/interfaces/_types_.triedb.md | 34 +++++------ docs/trie-db/modules/_constants_.md | 4 +- docs/trie-db/modules/_types_.md | 24 ++++---- docs/trie-db/modules/_util_is_.md | 10 ++-- docs/trie-db/modules/_util_key_.md | 24 ++++---- docs/trie-db/modules/_util_node_.md | 10 ++-- docs/trie-hash/index.html | 2 +- docs/trie-hash/modules/_buildtrie_.md | 2 +- docs/trie-hash/modules/_trieroot_.md | 2 +- docs/trie-hash/modules/_trierootordered_.md | 2 +- docs/trie-hash/modules/_types_.md | 2 +- docs/trie-hash/modules/_unhashedtrie_.md | 2 +- docs/util-crypto/index.html | 2 +- docs/util-crypto/modules/_blake2_ashex_.md | 6 +- docs/util-crypto/modules/_blake2_asu8a_.md | 6 +- .../modules/_blake2_blake2b_ashex_.md | 6 +- .../modules/_blake2_blake2b_asu8a_.md | 8 +-- docs/util-crypto/modules/_index_.md | 2 +- docs/util-crypto/modules/_keccak_ashex_.md | 6 +- docs/util-crypto/modules/_keccak_asu8a_.md | 6 +- .../modules/_mnemonic_generate_.md | 2 +- .../modules/_mnemonic_tosecret_.md | 2 +- docs/util-crypto/modules/_mnemonic_toseed_.md | 2 +- .../modules/_mnemonic_validate_.md | 2 +- docs/util-crypto/modules/_nacl_decrypt_.md | 6 +- docs/util-crypto/modules/_nacl_encrypt_.md | 2 +- .../modules/_nacl_keypair_fromrandom_.md | 2 +- .../modules/_nacl_keypair_fromsecret_.md | 2 +- .../modules/_nacl_keypair_fromseed_.md | 2 +- .../modules/_nacl_keypair_fromstring_.md | 2 +- docs/util-crypto/modules/_nacl_sign_.md | 2 +- docs/util-crypto/modules/_nacl_verify_.md | 2 +- docs/util-crypto/modules/_random_ashex_.md | 2 +- docs/util-crypto/modules/_random_asnumber_.md | 2 +- docs/util-crypto/modules/_random_asu8a_.md | 2 +- .../modules/_schnorrkel_keypair_fromseed_.md | 2 +- .../util-crypto/modules/_schnorrkel_ready_.md | 4 +- docs/util-crypto/modules/_schnorrkel_sign_.md | 2 +- .../modules/_schnorrkel_verify_.md | 2 +- docs/util-crypto/modules/_sha512_asu8a_.md | 2 +- docs/util-crypto/modules/_types_.md | 2 +- docs/util-crypto/modules/_xxhash_ashex_.md | 6 +- docs/util-crypto/modules/_xxhash_asu8a_.md | 6 +- .../modules/_xxhash_xxhash64_asbn_.md | 6 +- .../modules/_xxhash_xxhash64_ashex_.md | 6 +- .../modules/_xxhash_xxhash64_asraw_.md | 6 +- .../modules/_xxhash_xxhash64_asvalue_.md | 6 +- docs/util-rlp/modules/_decoder_decode_.md | 2 +- docs/util-rlp/modules/_decoder_index_.md | 8 +-- docs/util-rlp/modules/_decoder_listlong_.md | 2 +- docs/util-rlp/modules/_decoder_listshort_.md | 2 +- docs/util-rlp/modules/_decoder_number_.md | 2 +- .../modules/_decoder_safeparseint_.md | 2 +- docs/util-rlp/modules/_decoder_single_.md | 2 +- docs/util-rlp/modules/_decoder_string_.md | 2 +- docs/util-rlp/modules/_decoder_types_.md | 4 +- docs/util-rlp/modules/_encoder_array_.md | 2 +- docs/util-rlp/modules/_encoder_index_.md | 2 +- docs/util-rlp/modules/_encoder_length_.md | 2 +- docs/util-rlp/modules/_encoder_tou8a_.md | 2 +- docs/util-rlp/modules/_encoder_types_.md | 2 +- docs/util-rlp/modules/_encoder_u8a_.md | 2 +- docs/util/classes/_ext_error_.exterror.md | 24 ++++---- docs/util/index.html | 2 +- .../interfaces/_types_.exterrorinterface.md | 8 +-- docs/util/interfaces/_types_.tobnoptions.md | 8 +-- docs/util/modules/_array_filter_.md | 2 +- docs/util/modules/_assert_.md | 8 +-- docs/util/modules/_bn_tobn_.md | 6 +- docs/util/modules/_bn_tohex_.md | 8 +-- docs/util/modules/_bn_tou8a_.md | 16 +++--- docs/util/modules/_buffer_tou8a_.md | 6 +- docs/util/modules/_compact_addlength_.md | 2 +- docs/util/modules/_compact_defaults_.md | 2 +- docs/util/modules/_compact_fromu8a_.md | 6 +- docs/util/modules/_compact_striplength_.md | 2 +- docs/util/modules/_compact_tou8a_.md | 6 +- docs/util/modules/_compact_types_.md | 4 +- docs/util/modules/_hex_addprefix_.md | 6 +- docs/util/modules/_hex_fixlength_.md | 2 +- docs/util/modules/_hex_hasprefix_.md | 6 +- docs/util/modules/_hex_stripprefix_.md | 6 +- docs/util/modules/_hex_tobn_.md | 8 +-- docs/util/modules/_hex_tonumber_.md | 6 +- docs/util/modules/_hex_tou8a_.md | 6 +- docs/util/modules/_is_bn_.md | 2 +- docs/util/modules/_is_boolean_.md | 2 +- docs/util/modules/_is_buffer_.md | 2 +- docs/util/modules/_is_error_.md | 2 +- docs/util/modules/_is_function_.md | 2 +- docs/util/modules/_is_hex_.md | 2 +- docs/util/modules/_is_instanceof_.md | 2 +- docs/util/modules/_is_ip_.md | 2 +- docs/util/modules/_is_null_.md | 2 +- docs/util/modules/_is_number_.md | 2 +- docs/util/modules/_is_object_.md | 2 +- docs/util/modules/_is_observable_.md | 2 +- docs/util/modules/_is_string_.md | 2 +- docs/util/modules/_is_u8a_.md | 2 +- docs/util/modules/_is_undefined_.md | 2 +- docs/util/modules/_logger_.md | 4 +- docs/util/modules/_number_tohex_.md | 6 +- docs/util/modules/_number_tou8a_.md | 6 +- docs/util/modules/_promisify_.md | 2 +- docs/util/modules/_string_lowerfirst_.md | 6 +- docs/util/modules/_string_shorten_.md | 2 +- docs/util/modules/_string_tou8a_.md | 6 +- docs/util/modules/_string_upperfirst_.md | 6 +- docs/util/modules/_syncify_.md | 2 +- docs/util/modules/_types_.md | 6 +- docs/util/modules/_u8a_concat_.md | 6 +- docs/util/modules/_u8a_fixlength_.md | 2 +- docs/util/modules/_u8a_tobn_.md | 6 +- docs/util/modules/_u8a_tobuffer_.md | 6 +- docs/util/modules/_u8a_tohex_.md | 6 +- docs/util/modules/_u8a_tostring_.md | 6 +- docs/util/modules/_u8a_tou8a_.md | 6 +- lerna.json | 2 +- package.json | 2 +- packages/chainspec/package.json | 4 +- packages/db/package.json | 6 +- packages/keyring/package.json | 6 +- packages/trie-codec/package.json | 4 +- packages/trie-db/package.json | 16 +++--- packages/trie-hash/package.json | 6 +- packages/util-crypto/package.json | 4 +- packages/util-rlp/package.json | 4 +- packages/util/package.json | 2 +- yarn.lock | 50 +++-------------- 200 files changed, 681 insertions(+), 710 deletions(-) diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 866e18949..bce56ebdc 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 895cddd8e..3180b07ec 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/9f9ceff/packages/chainspec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/packages/chainspec/src/types.ts#L5)* #### Type declaration diff --git a/docs/db/classes/_disk_.diskdb.md b/docs/db/classes/_disk_.diskdb.md index ad7337a60..e4912aded 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/9f9ceff/packages/db/src/Disk.ts#L66)* +*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -160,13 +160,13 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *Implementation of [TxDb](../interfaces/_types_.txdb.md).[get](../interfaces/_types_.txdb.md#get)* *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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -174,7 +174,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/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 0a7724129..7d283d7cb 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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L46)* +*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L76)* +*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L50)* +*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L54)* +*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/FileTreeDb.ts#L54)* **Returns:** `void` @@ -104,11 +104,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L86)* +*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/FileTreeDb.ts#L86)* **Parameters:** @@ -116,7 +116,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L68)* +*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L42)* +*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L100)* +*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L58)* +*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/FileTreeDb.ts#L62)* +*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/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 d4a706db1..d0db1d191 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/9f9ceff/packages/db/src/engines/LruDb.ts#L20)* +*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/LruDb.ts#L20)* **Parameters:** @@ -35,9 +35,9 @@ ___ ## _getLru -▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` | `undefined` +▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` \| `undefined` -*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/9f9ceff/packages/db/src/engines/LruDb.ts#L87)* +*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/LruDb.ts#L87)* **Parameters:** @@ -45,7 +45,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `CachedValue` | `undefined` +**Returns:** `CachedValue` \| `undefined` ___ @@ -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/9f9ceff/packages/db/src/engines/LruDb.ts#L27)* +*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L64)* +*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L41)* +*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L45)* +*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/LruDb.ts#L45)* **Returns:** `void` @@ -110,11 +110,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/db/src/engines/LruDb.ts#L71)* +*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/LruDb.ts#L71)* **Parameters:** @@ -122,7 +122,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/LruDb.ts#L56)* +*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L34)* +*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L91)* +*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L52)* +*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/LruDb.ts#L60)* +*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/2efc5f7/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 b227dfca6..90dd27b04 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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L16)* +*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L22)* +*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L56)* +*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L30)* +*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L34)* +*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/MemoryDb.ts#L34)* **Returns:** `void` @@ -92,11 +92,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L62)* +*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/MemoryDb.ts#L62)* **Parameters:** @@ -104,7 +104,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L42)* +*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L26)* +*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L68)* +*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L38)* +*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/MemoryDb.ts#L50)* +*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/2efc5f7/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 cdcccf9f9..37959fa92 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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L21)* +*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -96,11 +96,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -108,7 +108,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/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 66541fffe..e43322961 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/9f9ceff/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/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 0af1aa459..df7d8ed77 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/9f9ceff/packages/db/src/FileFlatDb/Compact.ts#L17)* +*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/Compact.ts#L24)* +*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/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 0e769e9a8..bedc3bf70 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/9f9ceff/packages/db/src/FileFlatDb/File.ts#L19)* +*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/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 289af13a1..d5a68e8c4 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/9f9ceff/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/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 c623cefc9..7397dccfc 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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L18)* +*Defined in [FileFlatDb/index.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L31)* +*Defined in [FileFlatDb/index.ts:31](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L74)* +*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L39)* +*Defined in [FileFlatDb/index.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L45)* +*Defined in [FileFlatDb/index.ts:45](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/FileFlatDb/index.ts#L45)* **Returns:** `void` @@ -98,11 +98,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L78)* +*Defined in [FileFlatDb/index.ts:78](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/FileFlatDb/index.ts#L78)* **Parameters:** @@ -110,7 +110,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L66)* +*Defined in [FileFlatDb/index.ts:66](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L23)* +*Defined in [FileFlatDb/index.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L96)* +*Defined in [FileFlatDb/index.ts:96](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L55)* +*Defined in [FileFlatDb/index.ts:55](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/index.ts#L51)* +*Defined in [FileFlatDb/index.ts:51](https://github.com/polkadot-js/common/blob/2efc5f7/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 44dc32417..a6d151ee0 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/9f9ceff/packages/db/src/Memory.ts#L66)* +*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -156,13 +156,13 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *Implementation of [TxDb](../interfaces/_types_.txdb.md).[get](../interfaces/_types_.txdb.md#get)* *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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -170,7 +170,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/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 75e6c5650..d0bcf357c 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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L7)* +*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L6)* +*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L8)* +*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/FileFlatDb/types.ts#L8)* ___ diff --git a/docs/db/interfaces/_types_.basedb.md b/docs/db/interfaces/_types_.basedb.md index 4f2d8c920..b1fee056c 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/9f9ceff/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -69,9 +69,9 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/types.ts#L27)* **Parameters:** @@ -79,7 +79,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -88,7 +88,7 @@ ___ ▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void` -*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/9f9ceff/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/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 1f0caaac0..97e03b5d3 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/9f9ceff/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -76,11 +76,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *Inherited from [BaseDb](_types_.basedb.md).[get](_types_.basedb.md#get)* -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/types.ts#L27)* **Parameters:** @@ -88,7 +88,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -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/9f9ceff/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/db/modules/_fileflatdb_types_.md b/docs/db/modules/_fileflatdb_types_.md index 457c7a1ec..96f8b98a4 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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L16)* +*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L11)* +*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/FileFlatDb/types.ts#L22)* +*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/packages/db/src/FileFlatDb/types.ts#L22)* #### Type declaration diff --git a/docs/db/modules/_types_.md b/docs/db/modules/_types_.md index 1c6fc741b..92b15604f 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/9f9ceff/packages/db/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/db/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 d1ed54d0f..1268f3499 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 28cce92bc..7df20192e 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 b5bd3eacf..a67a2a71d 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 b7478d764..d7aa51677 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 c8a33b59b..a8c0583fc 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 b4d420634..ac0b18042 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 20f8fd7f4..30a8feca8 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 d17aba8a8..41094bb2d 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 4cf176223..b1a18d2aa 100644 --- a/docs/keyring/classes/_index_.keyring.md +++ b/docs/keyring/classes/_index_.keyring.md @@ -5,6 +5,7 @@ Overview -------- + *__name__*: Keyring *__summary__*: Keyring management of user accounts @@ -27,7 +28,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/9f9ceff/packages/keyring/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L32)* **Parameters:** @@ -49,7 +50,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/9f9ceff/packages/keyring/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L43)* ___ @@ -60,7 +61,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/9f9ceff/packages/keyring/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L44)* ___ @@ -71,7 +72,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/9f9ceff/packages/keyring/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L45)* ___ @@ -83,7 +84,7 @@ ___ gettype(): [KeyringPairType](../modules/_types_.md#keyringpairtype) -*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L50)* +*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L50)* *__description__*: Returns the type of the keyring, either ed25519 of sr25519 @@ -97,11 +98,11 @@ ___ ## addFromAddress -▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md) +▸ **addFromAddress**(address: *`string` \| `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` \| `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md) *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)* -*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L70)* *__name__*: addFromAddress @@ -113,9 +114,9 @@ ___ | Name | Type | Default value | | ------ | ------ | ------ | -| address | `string` | `Uint8Array` | - | +| address | `string` \| `Uint8Array` | - | | meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | - | -| encoded | `Uint8Array` | `null` | - | +| encoded | `Uint8Array` \| `null` | - | | `Default value` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | this.type | **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) @@ -127,7 +128,7 @@ ___ ▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L81)* +*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L81)* *__name__*: addFromJson @@ -152,7 +153,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)* -*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L96)* +*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L96)* *__name__*: addFromMnemonic @@ -179,7 +180,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)* -*Defined in [index.ts:107](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L107)* +*Defined in [index.ts:107](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L107)* *__name__*: addFromSeed @@ -206,7 +207,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)* -*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L58)* +*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L58)* *__name__*: addPair @@ -225,11 +226,11 @@ ___ ## getPair -▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md) +▸ **getPair**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md) *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)* -*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L121)* +*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L121)* *__name__*: getPair @@ -241,7 +242,7 @@ ___ | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) @@ -254,7 +255,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)* -*Defined in [index.ts:130](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L130)* *__name__*: getPairs @@ -273,7 +274,7 @@ ___ *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)* -*Defined in [index.ts:139](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L139)* +*Defined in [index.ts:139](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L139)* *__name__*: getPublicKeys @@ -288,11 +289,11 @@ ___ ## removePair -▸ **removePair**(address: *`string` | `Uint8Array`*): `void` +▸ **removePair**(address: *`string` \| `Uint8Array`*): `void` *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)* -*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L151)* +*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L151)* *__name__*: removePair @@ -302,7 +303,7 @@ ___ | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** `void` @@ -311,11 +312,11 @@ ___ ## toJson -▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) +▸ **toJson**(address: *`string` \| `Uint8Array`*, passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) *Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)* -*Defined in [index.ts:163](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L163)* +*Defined in [index.ts:163](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L163)* *__name__*: toJson @@ -327,8 +328,8 @@ ___ | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | -| `Optional` passphrase | `undefined` | `string` | +| address | `string` \| `Uint8Array` | +| `Optional` passphrase | `undefined` \| `string` | **Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json) diff --git a/docs/keyring/classes/_pairs_.pairs.md b/docs/keyring/classes/_pairs_.pairs.md index 76543317e..14f60ba67 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/9f9ceff/packages/keyring/src/pairs.ts#L17)* +*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L17)* **Returns:** [Pairs](_pairs_.pairs.md) @@ -30,7 +30,7 @@ ___ ▸ **add**(pair: *[KeyringPair](../interfaces/_types_.keyringpair.md)*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L23)* +*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L23)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **all**(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)> -*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L30)* +*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L30)* **Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)> @@ -56,15 +56,15 @@ ___ ## get -▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md) +▸ **get**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L34)* +*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L34)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) @@ -73,15 +73,15 @@ ___ ## remove -▸ **remove**(address: *`string` | `Uint8Array`*): `void` +▸ **remove**(address: *`string` \| `Uint8Array`*): `void` -*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L49)* +*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L49)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** `void` diff --git a/docs/keyring/index.html b/docs/keyring/index.html index 4acf5cf1f..737d19c40 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 cb44f62c8..9227d094d 100644 --- a/docs/keyring/interfaces/_types_.keyringinstance.md +++ b/docs/keyring/interfaces/_types_.keyringinstance.md @@ -16,7 +16,7 @@ **● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)* -*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L58)* ___ @@ -26,17 +26,17 @@ ___ ## addFromAddress -▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) +▸ **addFromAddress**(address: *`string` \| `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` \| `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L65)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | | meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | -| encoded | `Uint8Array` | `null` | +| encoded | `Uint8Array` \| `null` | | `Optional` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | **Returns:** [KeyringPair](_types_.keyringpair.md) @@ -48,7 +48,7 @@ ___ ▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L68)* **Parameters:** @@ -65,7 +65,7 @@ ___ ▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L66)* **Parameters:** @@ -84,7 +84,7 @@ ___ ▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L67)* **Parameters:** @@ -103,7 +103,7 @@ ___ ▸ **addPair**(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L64)* **Parameters:** @@ -118,15 +118,15 @@ ___ ## decodeAddress -▸ **decodeAddress**(encoded: *`string` | `Uint8Array`*): `Uint8Array` +▸ **decodeAddress**(encoded: *`string` \| `Uint8Array`*): `Uint8Array` -*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L60)* **Parameters:** | Name | Type | | ------ | ------ | -| encoded | `string` | `Uint8Array` | +| encoded | `string` \| `Uint8Array` | **Returns:** `Uint8Array` @@ -135,15 +135,15 @@ ___ ## encodeAddress -▸ **encodeAddress**(key: *`Uint8Array` | `string`*): `string` +▸ **encodeAddress**(key: *`Uint8Array` \| `string`*): `string` -*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L61)* **Parameters:** | Name | Type | | ------ | ------ | -| key | `Uint8Array` | `string` | +| key | `Uint8Array` \| `string` | **Returns:** `string` @@ -152,15 +152,15 @@ ___ ## getPair -▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) +▸ **getPair**(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L69)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** [KeyringPair](_types_.keyringpair.md) @@ -171,7 +171,7 @@ ___ ▸ **getPairs**(): `Array`<[KeyringPair](_types_.keyringpair.md)> -*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L70)* **Returns:** `Array`<[KeyringPair](_types_.keyringpair.md)> @@ -182,7 +182,7 @@ ___ ▸ **getPublicKeys**(): `Array`<`Uint8Array`> -*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L71)* **Returns:** `Array`<`Uint8Array`> @@ -191,15 +191,15 @@ ___ ## removePair -▸ **removePair**(address: *`string` | `Uint8Array`*): `void` +▸ **removePair**(address: *`string` \| `Uint8Array`*): `void` -*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L72)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** `void` @@ -210,7 +210,7 @@ ___ ▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void` -*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L62)* **Parameters:** @@ -225,16 +225,16 @@ ___ ## toJson -▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) +▸ **toJson**(address: *`string` \| `Uint8Array`*, passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) -*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L73)* **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | -| `Optional` passphrase | `undefined` | `string` | +| address | `string` \| `Uint8Array` | +| `Optional` passphrase | `undefined` \| `string` | **Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json) diff --git a/docs/keyring/interfaces/_types_.keyringpair.md b/docs/keyring/interfaces/_types_.keyringpair.md index 89778efe4..1efe96cf9 100644 --- a/docs/keyring/interfaces/_types_.keyringpair.md +++ b/docs/keyring/interfaces/_types_.keyringpair.md @@ -12,7 +12,7 @@ **● address**: *`function`* -*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L36)* #### Type declaration ▸(): `string` @@ -26,16 +26,16 @@ ___ **● decodePkcs8**: *`function`* -*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L37)* #### Type declaration -▸(passphrase?: *`undefined` | `string`*, encoded?: *`Uint8Array`*): `void` +▸(passphrase?: *`undefined` \| `string`*, encoded?: *`Uint8Array`*): `void` **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` passphrase | `undefined` | `string` | +| `Optional` passphrase | `undefined` \| `string` | | `Optional` encoded | `Uint8Array` | **Returns:** `void` @@ -47,16 +47,16 @@ ___ **● encodePkcs8**: *`function`* -*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L38)* #### Type declaration -▸(passphrase?: *`undefined` | `string`*): `Uint8Array` +▸(passphrase?: *`undefined` \| `string`*): `Uint8Array` **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` passphrase | `undefined` | `string` | +| `Optional` passphrase | `undefined` \| `string` | **Returns:** `Uint8Array` @@ -67,7 +67,7 @@ ___ **● getMeta**: *`function`* -*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L39)* #### Type declaration ▸(): [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) @@ -81,7 +81,7 @@ ___ **● isLocked**: *`function`* -*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L40)* #### Type declaration ▸(): `boolean` @@ -95,7 +95,7 @@ ___ **● lock**: *`function`* -*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L41)* #### Type declaration ▸(): `void` @@ -109,7 +109,7 @@ ___ **● publicKey**: *`function`* -*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L42)* #### Type declaration ▸(): `Uint8Array` @@ -123,7 +123,7 @@ ___ **● setMeta**: *`function`* -*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L43)* #### Type declaration ▸(meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): `void` @@ -143,7 +143,7 @@ ___ **● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)* -*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L34)* ___ @@ -155,7 +155,7 @@ ___ ▸ **sign**(message: *`Uint8Array`*): `Uint8Array` -*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L44)* **Parameters:** @@ -170,15 +170,15 @@ ___ ## toJson -▸ **toJson**(passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) +▸ **toJson**(passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) -*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L45)* **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` passphrase | `undefined` | `string` | +| `Optional` passphrase | `undefined` \| `string` | **Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json) @@ -189,7 +189,7 @@ ___ ▸ **toType**(type: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L46)* **Parameters:** @@ -206,7 +206,7 @@ ___ ▸ **verify**(message: *`Uint8Array`*, signature: *`Uint8Array`*): `boolean` -*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L47)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpairs.md b/docs/keyring/interfaces/_types_.keyringpairs.md index 33dc456b6..65046daa6 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:51](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L51)* #### Type declaration ▸(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md) @@ -36,7 +36,7 @@ ___ **● all**: *`function`* -*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L52)* #### Type declaration ▸(): `Array`<[KeyringPair](_types_.keyringpair.md)> @@ -50,16 +50,16 @@ ___ **● get**: *`function`* -*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L53)* #### Type declaration -▸(address: *`string` | `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) +▸(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** [KeyringPair](_types_.keyringpair.md) @@ -70,16 +70,16 @@ ___ **● remove**: *`function`* -*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L54)* #### Type declaration -▸(address: *`string` | `Uint8Array`*): `void` +▸(address: *`string` \| `Uint8Array`*): `void` **Parameters:** | Name | Type | | ------ | ------ | -| address | `string` | `Uint8Array` | +| address | `string` \| `Uint8Array` | **Returns:** `void` diff --git a/docs/keyring/modules/_address_decode_.md b/docs/keyring/modules/_address_decode_.md index 947629809..dadc62bb5 100644 --- a/docs/keyring/modules/_address_decode_.md +++ b/docs/keyring/modules/_address_decode_.md @@ -6,15 +6,15 @@ ## decode -▸ **decode**(encoded: *`string` | `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array` +▸ **decode**(encoded: *`string` \| `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array` -*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/address/decode.ts#L15)* +*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/address/decode.ts#L15)* **Parameters:** | Name | Type | Default value | | ------ | ------ | ------ | -| encoded | `string` | `Uint8Array` | - | +| encoded | `string` \| `Uint8Array` | - | | `Default value` prefix | [Prefix](_address_types_.md#prefix) | defaults.prefix | **Returns:** `Uint8Array` diff --git a/docs/keyring/modules/_address_encode_.md b/docs/keyring/modules/_address_encode_.md index 95456c3c2..281add1d7 100644 --- a/docs/keyring/modules/_address_encode_.md +++ b/docs/keyring/modules/_address_encode_.md @@ -6,15 +6,15 @@ ## encode -▸ **encode**(_key: *`Uint8Array` | `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string` +▸ **encode**(_key: *`Uint8Array` \| `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string` -*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/address/encode.ts#L15)* +*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/address/encode.ts#L15)* **Parameters:** | Name | Type | Default value | | ------ | ------ | ------ | -| _key | `Uint8Array` | `string` | - | +| _key | `Uint8Array` \| `string` | - | | `Default value` prefix | [Prefix](_address_types_.md#prefix) | defaults.prefix | **Returns:** `string` diff --git a/docs/keyring/modules/_address_setprefix_.md b/docs/keyring/modules/_address_setprefix_.md index b1b46f1b6..7638cdf5a 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/9f9ceff/packages/keyring/src/address/setPrefix.ts#L9)* +*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/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 71f19f6ae..0ca141e5b 100644 --- a/docs/keyring/modules/_address_types_.md +++ b/docs/keyring/modules/_address_types_.md @@ -6,9 +6,9 @@ ## Prefix -**Ƭ Prefix**: *`0` | `1` | `3` | `42` | `43` | `68` | `69`* +**Ƭ Prefix**: *`0` \| `1` \| `3` \| `42` \| `43` \| `68` \| `69`* -*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/address/types.ts#L5)* +*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/address/types.ts#L5)* ___ diff --git a/docs/keyring/modules/_pair_decode_.md b/docs/keyring/modules/_pair_decode_.md index 22acb7a1d..a55dc3de0 100644 --- a/docs/keyring/modules/_pair_decode_.md +++ b/docs/keyring/modules/_pair_decode_.md @@ -6,16 +6,16 @@ ## decode -▸ **decode**(passphrase?: *`undefined` | `string`*, _encrypted?: *`Uint8Array` | `null`*): `DecodeResult` +▸ **decode**(passphrase?: *`undefined` \| `string`*, _encrypted?: *`Uint8Array` \| `null`*): `DecodeResult` -*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pair/decode.ts#L19)* +*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pair/decode.ts#L19)* **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` passphrase | `undefined` | `string` | -| `Optional` _encrypted | `Uint8Array` | `null` | +| `Optional` passphrase | `undefined` \| `string` | +| `Optional` _encrypted | `Uint8Array` \| `null` | **Returns:** `DecodeResult` diff --git a/docs/keyring/modules/_pair_encode_.md b/docs/keyring/modules/_pair_encode_.md index 41f19b4a1..ce30e8608 100644 --- a/docs/keyring/modules/_pair_encode_.md +++ b/docs/keyring/modules/_pair_encode_.md @@ -6,16 +6,16 @@ ## encode -▸ **encode**(__namedParameters: *`object`*, passphrase?: *`undefined` | `string`*): `Uint8Array` +▸ **encode**(__namedParameters: *`object`*, passphrase?: *`undefined` \| `string`*): `Uint8Array` -*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pair/encode.ts#L12)* +*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pair/encode.ts#L12)* **Parameters:** | Name | Type | | ------ | ------ | | __namedParameters | `object` | -| `Optional` passphrase | `undefined` | `string` | +| `Optional` passphrase | `undefined` \| `string` | **Returns:** `Uint8Array` diff --git a/docs/keyring/modules/_pair_index_.md b/docs/keyring/modules/_pair_index_.md index 83cca9ae4..330fb1e8c 100644 --- a/docs/keyring/modules/_pair_index_.md +++ b/docs/keyring/modules/_pair_index_.md @@ -6,9 +6,9 @@ ## createPair -▸ **createPair**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](../interfaces/_types_.keyringpair.md) +▸ **createPair**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` \| `null`*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pair/index.ts:62](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pair/index.ts#L62)* +*Defined in [pair/index.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pair/index.ts#L62)* *__name__*: pair @@ -33,7 +33,7 @@ It has properties whose values are functions that may be called to perform accou | type | [KeyringPairType](_types_.md#keyringpairtype) | - | | __namedParameters | `object` | - | | `Default value` meta | [KeyringPair$Meta](_types_.md#keyringpair_meta) | {} | -| encoded | `Uint8Array` | `null` | - | +| encoded | `Uint8Array` \| `null` | - | **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) diff --git a/docs/keyring/modules/_pair_nobody_.md b/docs/keyring/modules/_pair_nobody_.md index 38d4baf1f..9e83a46af 100644 --- a/docs/keyring/modules/_pair_nobody_.md +++ b/docs/keyring/modules/_pair_nobody_.md @@ -8,7 +8,7 @@ ▸ **everybody**(): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pair/nobody.ts#L25)* +*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pair/nobody.ts#L25)* **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) diff --git a/docs/keyring/modules/_pair_tojson_.md b/docs/keyring/modules/_pair_tojson_.md index bd1e4f398..2c8251a34 100644 --- a/docs/keyring/modules/_pair_tojson_.md +++ b/docs/keyring/modules/_pair_tojson_.md @@ -8,7 +8,7 @@ ▸ **toJson**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __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/9f9ceff/packages/keyring/src/pair/toJson.ts#L15)* +*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/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 50bdb2211..a6f81a623 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/9f9ceff/packages/keyring/src/pair/types.ts#L5)* +*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pair/types.ts#L5)* #### Type declaration diff --git a/docs/keyring/modules/_testing_.md b/docs/keyring/modules/_testing_.md index 29e7c17b3..5c372a237 100644 --- a/docs/keyring/modules/_testing_.md +++ b/docs/keyring/modules/_testing_.md @@ -8,7 +8,7 @@ ▸ **testKeyring**(options: *[KeyringOptions](_types_.md#keyringoptions)*): [KeyringInstance](../interfaces/_types_.keyringinstance.md) -*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/testing.ts#L41)* +*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/testing.ts#L41)* *__name__*: testKeyring diff --git a/docs/keyring/modules/_testingpairs_.md b/docs/keyring/modules/_testingpairs_.md index ecabe09cf..13fe3a9b9 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/9f9ceff/packages/keyring/src/testingPairs.ts#L14)* +*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/testingPairs.ts#L14)* **Parameters:** diff --git a/docs/keyring/modules/_types_.md b/docs/keyring/modules/_types_.md index 60a05fc0c..44c1b461e 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/9f9ceff/packages/keyring/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L9)* #### Type declaration @@ -38,7 +38,7 @@ ___ **Ƭ KeyringPair$Json**: *`object`* -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L26)* #### Type declaration @@ -49,7 +49,7 @@ ___ **Ƭ KeyringPair$JsonEncoding**: *`object`* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L20)* #### Type declaration @@ -58,9 +58,9 @@ ___ ## KeyringPair$JsonVersion -**Ƭ KeyringPair$JsonVersion**: *"0" | "1"* +**Ƭ KeyringPair$JsonVersion**: *"0" \| "1"* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L18)* ___ @@ -69,7 +69,7 @@ ___ **Ƭ KeyringPair$Meta**: *`object`* -*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L14)* #### Type declaration @@ -80,9 +80,9 @@ ___ ## KeyringPairType -**Ƭ KeyringPairType**: *"ed25519" | "sr25519"* +**Ƭ KeyringPairType**: *"ed25519" \| "sr25519"* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/types.ts#L7)* ___ diff --git a/docs/trie-codec/classes/_nodeheader_.branchheader.md b/docs/trie-codec/classes/_nodeheader_.branchheader.md index d33146d4f..95d83526b 100644 --- a/docs/trie-codec/classes/_nodeheader_.branchheader.md +++ b/docs/trie-codec/classes/_nodeheader_.branchheader.md @@ -14,7 +14,7 @@ **● Boolean**: *`BooleanConstructor`* -*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:530* +*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540* ___ @@ -28,7 +28,7 @@ ___ *Inherited from Boolean.valueOf* -*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:521* +*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531* Returns the primitive value of the specified object. diff --git a/docs/trie-codec/classes/_nodeheader_.extensionheader.md b/docs/trie-codec/classes/_nodeheader_.extensionheader.md index a38e53821..1a1742430 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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/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 28041902c..2059ca878 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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/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 05eaee3a4..3a09445d1 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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/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 b61194205..6aac14e9e 100644 --- a/docs/trie-codec/classes/_nodeheader_.nodeheader.md +++ b/docs/trie-codec/classes/_nodeheader_.nodeheader.md @@ -10,15 +10,15 @@ ## constructor -⊕ **new NodeHeader**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md) +⊕ **new NodeHeader**(input?: *`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md) -*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L40)* +*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/NodeHeader.ts#L40)* **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` input | `null` | `Uint8Array` | `Array`<`null` | `Uint8Array`> | +| `Optional` input | `null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`> | **Returns:** [NodeHeader](_nodeheader_.nodeheader.md) @@ -32,7 +32,7 @@ ___ getencodedLength(): `number` -*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L92)* +*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L114)* +*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/NodeHeader.ts#L114)* **Returns:** `number` @@ -52,11 +52,11 @@ ___ ## value -getvalue(): [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md) +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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L118)* +*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/NodeHeader.ts#L118)* -**Returns:** [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md) +**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/9f9ceff/packages/trie-codec/src/NodeHeader.ts#L122)* +*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/2efc5f7/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 d4f9b6d4d..10253760c 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/9f9ceff/packages/trie-codec/src/constants.ts#L10)* +*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L11)* +*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L5)* +*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L8)* +*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L15)* +*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L13)* +*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L7)* +*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L6)* +*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L12)* +*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L17)* +*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L18)* +*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L19)* +*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/constants.ts#L16)* +*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/constants.ts#L16)* ___ diff --git a/docs/trie-codec/modules/_decode_.md b/docs/trie-codec/modules/_decode_.md index c546d3952..cd797ae36 100644 --- a/docs/trie-codec/modules/_decode_.md +++ b/docs/trie-codec/modules/_decode_.md @@ -6,17 +6,17 @@ ## decode -▸ **decode**(input: *`null` | `Uint8Array`*): `Uint8Array` | `null` | `Array`<`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>> +▸ **decode**(input: *`null` \| `Uint8Array`*): `Uint8Array` \| `null` \| `Array`<`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>> -*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/decode.ts#L95)* +*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/decode.ts#L95)* **Parameters:** | Name | Type | | ------ | ------ | -| input | `null` | `Uint8Array` | +| input | `null` \| `Uint8Array` | -**Returns:** `Uint8Array` | `null` | `Array`<`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>> +**Returns:** `Uint8Array` \| `null` \| `Array`<`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>> ___ diff --git a/docs/trie-codec/modules/_encode_.md b/docs/trie-codec/modules/_encode_.md index 453e46903..06f8d7584 100644 --- a/docs/trie-codec/modules/_encode_.md +++ b/docs/trie-codec/modules/_encode_.md @@ -6,15 +6,15 @@ ## encode -▸ **encode**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): `Uint8Array` +▸ **encode**(input?: *`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>*): `Uint8Array` -*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/encode.ts#L101)* +*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/encode.ts#L101)* **Parameters:** | Name | Type | | ------ | ------ | -| `Optional` input | `null` | `Uint8Array` | `Array`<`null` | `Uint8Array`> | +| `Optional` input | `null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`> | **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_nibbles_.md b/docs/trie-codec/modules/_nibbles_.md index eb27a9019..7dc2d2605 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/9f9ceff/packages/trie-codec/src/nibbles.ts#L31)* +*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/nibbles.ts#L31)* **Parameters:** @@ -23,15 +23,15 @@ ___ ## decodeNibbles -▸ **decodeNibbles**(value: *`null` | `Uint8Array`*): `Uint8Array` +▸ **decodeNibbles**(value: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/nibbles.ts#L52)* +*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/nibbles.ts#L52)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `null` | `Uint8Array` | +| value | `null` \| `Uint8Array` | **Returns:** `Uint8Array` @@ -42,7 +42,7 @@ ___ ▸ **encodeNibbles**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/nibbles.ts#L65)* +*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/nibbles.ts#L65)* **Parameters:** @@ -57,15 +57,15 @@ ___ ## extractKey -▸ **extractKey**(key: *`null` | `Uint8Array`*): `Uint8Array` +▸ **extractKey**(key: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/nibbles.ts#L15)* +*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/nibbles.ts#L15)* **Parameters:** | Name | Type | | ------ | ------ | -| key | `null` | `Uint8Array` | +| key | `null` \| `Uint8Array` | **Returns:** `Uint8Array` @@ -74,15 +74,15 @@ ___ ## extractNodeKey -▸ **extractNodeKey**(__namedParameters: *[`null` | `Uint8Array`]*): `Uint8Array` +▸ **extractNodeKey**(__namedParameters: *[`null` \| `Uint8Array`]*): `Uint8Array` -*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/nibbles.ts#L21)* +*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/nibbles.ts#L21)* **Parameters:** | Name | Type | | ------ | ------ | -| __namedParameters | [`null` | `Uint8Array`] | +| __namedParameters | [`null` \| `Uint8Array`] | **Returns:** `Uint8Array` @@ -93,7 +93,7 @@ ___ ▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean` -*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/nibbles.ts#L27)* +*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-codec/src/nibbles.ts#L44)* +*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/2efc5f7/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 9b1ff6a62..676f788bd 100644 --- a/docs/trie-codec/modules/_stream_createbranch_.md +++ b/docs/trie-codec/modules/_stream_createbranch_.md @@ -6,15 +6,15 @@ ## createBranch -▸ **createBranch**(value: *`Uint8Array` | `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array` +▸ **createBranch**(value: *`Uint8Array` \| `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array` -*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/stream/createBranch.ts#L10)* +*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/stream/createBranch.ts#L10)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `Uint8Array` | `null` | +| value | `Uint8Array` \| `null` | | hasChildren | `Array`<`boolean`> | **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_stream_createempty_.md b/docs/trie-codec/modules/_stream_createempty_.md index 6738808dd..bbf525638 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/9f9ceff/packages/trie-codec/src/stream/createEmpty.ts#L7)* +*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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 4f1ad873f..b2df1a8d2 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/9f9ceff/packages/trie-codec/src/stream/createExtension.ts#L7)* +*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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 c79fe0c3c..50f772d81 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/9f9ceff/packages/trie-codec/src/stream/createLeaf.ts#L10)* +*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/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 aa288500f..d45591256 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/9f9ceff/packages/trie-codec/src/stream/createSubstream.ts#L8)* +*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/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 e795518e8..dfa0c7048 100644 --- a/docs/trie-codec/modules/_stream_createvalue_.md +++ b/docs/trie-codec/modules/_stream_createvalue_.md @@ -6,15 +6,15 @@ ## createValue -▸ **createValue**(value: *`null` | `Uint8Array`*): `Uint8Array` +▸ **createValue**(value: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/stream/createValue.ts#L9)* +*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/stream/createValue.ts#L9)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `null` | `Uint8Array` | +| value | `null` \| `Uint8Array` | **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_stream_endbranch_.md b/docs/trie-codec/modules/_stream_endbranch_.md index d60745bb9..a3a64d2e3 100644 --- a/docs/trie-codec/modules/_stream_endbranch_.md +++ b/docs/trie-codec/modules/_stream_endbranch_.md @@ -6,15 +6,15 @@ ## encBranch -▸ **encBranch**(value: *`Uint8Array` | `null`*): `Uint8Array` +▸ **encBranch**(value: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/stream/endBranch.ts#L7)* +*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/stream/endBranch.ts#L7)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `Uint8Array` | `null` | +| value | `Uint8Array` \| `null` | **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_types_.md b/docs/trie-codec/modules/_types_.md index dc41de90f..0fceee373 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/9f9ceff/packages/trie-codec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 7da5801c2..37b0b89d9 100644 --- a/docs/trie-codec/modules/_util_fromnibbles_.md +++ b/docs/trie-codec/modules/_util_fromnibbles_.md @@ -8,7 +8,7 @@ ▸ **fromNibbles**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/util/fromNibbles.ts#L19)* +*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/util/fromNibbles.ts#L19)* *__name__*: fromNibbles diff --git a/docs/trie-codec/modules/_util_fusenibbles_.md b/docs/trie-codec/modules/_util_fusenibbles_.md index f1ac4447e..c640e2968 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/9f9ceff/packages/trie-codec/src/util/fuseNibbles.ts#L12)* +*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/2efc5f7/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 82e3f80d5..16683c304 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/9f9ceff/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* +*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 a7d69e475..d31b674a1 100644 --- a/docs/trie-codec/modules/_util_tonibbles_.md +++ b/docs/trie-codec/modules/_util_tonibbles_.md @@ -6,9 +6,9 @@ ## toNibbles -▸ **toNibbles**(input?: *`Uint8Array` | `null`*): `Uint8Array` +▸ **toNibbles**(input?: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-codec/src/util/toNibbles.ts#L19)* +*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-codec/src/util/toNibbles.ts#L19)* *__name__*: toNibbles @@ -28,7 +28,7 @@ toNibbles(new Uint8Array([0x41, 0x20]); // => Uint8Array([4, 1, 2, 0]) | Name | Type | | ------ | ------ | -| `Optional` input | `Uint8Array` | `null` | +| `Optional` input | `Uint8Array` \| `null` | **Returns:** `Uint8Array` diff --git a/docs/trie-db/classes/_checkpoint_.checkpoint.md b/docs/trie-db/classes/_checkpoint_.checkpoint.md index f8004c6a1..a8073f5b1 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/9f9ceff/packages/trie-db/src/Checkpoint.ts#L7)* +*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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 304ee8b08..589d728c9 100644 --- a/docs/trie-db/classes/_impl_.impl.md +++ b/docs/trie-db/classes/_impl_.impl.md @@ -5,6 +5,7 @@ Overview -------- + *__name__*: Trie *__summary__*: Re-implementation of a Patricia Trie @@ -29,7 +30,7 @@ Overview *Overrides [Checkpoint](_checkpoint_.checkpoint.md).[constructor](_checkpoint_.checkpoint.md#constructor)* -*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/Impl.ts#L38)* +*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/Impl.ts#L38)* **Parameters:** @@ -51,7 +52,7 @@ ___ **● db**: *`TxDb`* -*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/2efc5f7/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 0008d00ec..7ad31725a 100644 --- a/docs/trie-db/classes/_index_.trie.md +++ b/docs/trie-db/classes/_index_.trie.md @@ -5,6 +5,7 @@ Overview -------- + *__name__*: Trie *__summary__*: Re-implementation of a Patricia Trie @@ -31,7 +32,7 @@ Overview *Overrides [Impl](_impl_.impl.md).[constructor](_impl_.impl.md#constructor)* -*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L27)* **Parameters:** @@ -57,7 +58,7 @@ ___ *Inherited from [Impl](_impl_.impl.md).[db](_impl_.impl.md#db)* -*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/Impl.ts#L36)* ___ @@ -71,7 +72,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/9f9ceff/packages/trie-db/src/index.ts#L58)* +*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L58)* **Returns:** `void` @@ -84,7 +85,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/9f9ceff/packages/trie-db/src/index.ts#L82)* +*Defined in [index.ts:82](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L82)* **Parameters:** @@ -103,7 +104,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/9f9ceff/packages/trie-db/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L66)* **Returns:** `void` @@ -116,7 +117,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/9f9ceff/packages/trie-db/src/index.ts#L62)* +*Defined in [index.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L62)* **Returns:** `void` @@ -125,11 +126,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/packages/trie-db/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L93)* **Parameters:** @@ -137,7 +138,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -146,7 +147,7 @@ ___ ▸ **getNode**(hash?: *`Uint8Array`*): [Node](../modules/_types_.md#node) -*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/index.ts#L124)* +*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L124)* **Parameters:** @@ -165,7 +166,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/9f9ceff/packages/trie-db/src/index.ts#L114)* +*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L114)* **Returns:** `Uint8Array` @@ -178,7 +179,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/9f9ceff/packages/trie-db/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L70)* **Parameters:** @@ -197,7 +198,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/9f9ceff/packages/trie-db/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L54)* **Returns:** `void` @@ -210,7 +211,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/9f9ceff/packages/trie-db/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L102)* **Parameters:** @@ -230,7 +231,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/9f9ceff/packages/trie-db/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L74)* **Parameters:** @@ -250,7 +251,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/9f9ceff/packages/trie-db/src/index.ts#L128)* +*Defined in [index.ts:128](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L128)* **Parameters:** @@ -269,7 +270,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/9f9ceff/packages/trie-db/src/index.ts#L78)* +*Defined in [index.ts:78](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L78)* **Returns:** `number` @@ -282,7 +283,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/9f9ceff/packages/trie-db/src/index.ts#L133)* +*Defined in [index.ts:133](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/index.ts#L133)* **Parameters:** @@ -300,7 +301,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/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 be3d64c5f..a29f18ed4 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/9f9ceff/packages/trie-db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L9)* ___ diff --git a/docs/trie-db/index.html b/docs/trie-db/index.html index 7935c1cc6..cb8060079 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 a976af753..8148ff334 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/9f9ceff/packages/trie-db/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -86,11 +86,11 @@ ___ ## get -▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null` +▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` *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/9f9ceff/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/2efc5f7/packages/db/src/types.ts#L27)* **Parameters:** @@ -98,7 +98,7 @@ ___ | ------ | ------ | | key | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ @@ -107,7 +107,7 @@ ___ ▸ **getRoot**(): `Uint8Array` -*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/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/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/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/2efc5f7/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/trie-db/modules/_constants_.md b/docs/trie-db/modules/_constants_.md index 7ec385f0a..f1d3cb6cf 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/9f9ceff/packages/trie-db/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/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 ee327f321..c0d221871 100644 --- a/docs/trie-db/modules/_types_.md +++ b/docs/trie-db/modules/_types_.md @@ -29,18 +29,18 @@ ## EncodedPath -**Ƭ EncodedPath**: *`Uint8Array` | `null`* +**Ƭ EncodedPath**: *`Uint8Array` \| `null`* -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L28)* ___ ## Node -**Ƭ Node**: *[NodeEmpty](_types_.md#nodeempty) | [NodeNotEmpty](_types_.md#nodenotempty)* +**Ƭ Node**: *[NodeEmpty](_types_.md#nodeempty) \| [NodeNotEmpty](_types_.md#nodenotempty)* -*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L14)* ___ @@ -67,16 +67,16 @@ ___ **Ƭ NodeEncoded**: *`Uint8Array`* -*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L16)* ___ ## NodeEncodedOrEmpty -**Ƭ NodeEncodedOrEmpty**: *[NodeEncoded](_types_.md#nodeencoded) | [NodeEmpty](_types_.md#nodeempty)* +**Ƭ NodeEncodedOrEmpty**: *[NodeEncoded](_types_.md#nodeencoded) \| [NodeEmpty](_types_.md#nodeempty)* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L18)* ___ @@ -85,16 +85,16 @@ ___ **Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]* -*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/types.ts#L30)* ___ ## NodeNotEmpty -**Ƭ NodeNotEmpty**: *[NodeKv](_types_.md#nodekv) | [NodeBranch](_types_.md#nodebranch)* +**Ƭ NodeNotEmpty**: *[NodeKv](_types_.md#nodekv) \| [NodeBranch](_types_.md#nodebranch)* -*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/2efc5f7/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 497dcf919..fbfc1173f 100644 --- a/docs/trie-db/modules/_util_is_.md +++ b/docs/trie-db/modules/_util_is_.md @@ -8,7 +8,7 @@ ▸ **isBranchNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/is.ts#L52)* +*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/is.ts#L52)* *__name__*: isBranchNode @@ -31,7 +31,7 @@ ___ ▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/is.ts#L16)* +*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/is.ts#L16)* *__name__*: isEmptyNode @@ -54,7 +54,7 @@ ___ ▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/is.ts#L34)* +*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/is.ts#L34)* *__name__*: isExtensionNode @@ -77,7 +77,7 @@ ___ ▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/is.ts#L25)* +*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/is.ts#L25)* *__name__*: isKvNode @@ -100,7 +100,7 @@ ___ ▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/is.ts#L43)* +*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/is.ts#L43)* *__name__*: isLeafNode diff --git a/docs/trie-db/modules/_util_key_.md b/docs/trie-db/modules/_util_key_.md index 482174083..e51920d20 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/9f9ceff/packages/trie-db/src/util/key.ts#L36)* +*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/util/key.ts#L40)* +*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/util/key.ts#L56)* +*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/util/key.ts#L46)* +*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/key.ts#L46)* **Parameters:** @@ -76,16 +76,16 @@ ___ ## keyEquals -▸ **keyEquals**(key: *`Uint8Array` | `null`*, test: *`Uint8Array` | `null`*): `boolean` +▸ **keyEquals**(key: *`Uint8Array` \| `null`*, test: *`Uint8Array` \| `null`*): `boolean` -*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/key.ts#L10)* +*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/key.ts#L10)* **Parameters:** | Name | Type | | ------ | ------ | -| key | `Uint8Array` | `null` | -| test | `Uint8Array` | `null` | +| key | `Uint8Array` \| `null` | +| test | `Uint8Array` \| `null` | **Returns:** `boolean` @@ -94,16 +94,16 @@ ___ ## keyStartsWith -▸ **keyStartsWith**(key: *`Uint8Array` | `null`*, partial: *`Uint8Array` | `null`*): `boolean` +▸ **keyStartsWith**(key: *`Uint8Array` \| `null`*, partial: *`Uint8Array` \| `null`*): `boolean` -*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-db/src/util/key.ts#L20)* +*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/key.ts#L20)* **Parameters:** | Name | Type | | ------ | ------ | -| key | `Uint8Array` | `null` | -| partial | `Uint8Array` | `null` | +| key | `Uint8Array` \| `null` | +| partial | `Uint8Array` \| `null` | **Returns:** `boolean` diff --git a/docs/trie-db/modules/_util_node_.md b/docs/trie-db/modules/_util_node_.md index 0a6fd052c..255d1d64f 100644 --- a/docs/trie-db/modules/_util_node_.md +++ b/docs/trie-db/modules/_util_node_.md @@ -6,16 +6,16 @@ ## decodeNode -▸ **decodeNode**(codec: *`Codec`*, encoded: *`Uint8Array` | [Node](_types_.md#node)*): [Node](_types_.md#node) +▸ **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/9f9ceff/packages/trie-db/src/util/node.ts#L30)* +*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/node.ts#L30)* **Parameters:** | Name | Type | | ------ | ------ | | codec | `Codec` | -| encoded | `Uint8Array` | [Node](_types_.md#node) | +| encoded | `Uint8Array` \| [Node](_types_.md#node) | **Returns:** [Node](_types_.md#node) @@ -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/9f9ceff/packages/trie-db/src/util/node.ts#L46)* +*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/trie-db/src/util/node.ts#L13)* +*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-db/src/util/node.ts#L13)* **Parameters:** diff --git a/docs/trie-hash/index.html b/docs/trie-hash/index.html index 8d4df4561..125cacb82 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 42aefd419..5f2a06a5d 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/9f9ceff/packages/trie-hash/src/buildTrie.ts#L77)* +*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/2efc5f7/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 a4a9cc54e..2ef8af92a 100644 --- a/docs/trie-hash/modules/_trieroot_.md +++ b/docs/trie-hash/modules/_trieroot_.md @@ -8,7 +8,7 @@ ▸ **trieRoot**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-hash/src/trieRoot.ts#L29)* +*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-hash/src/trieRoot.ts#L29)* *__name__*: trieRoot diff --git a/docs/trie-hash/modules/_trierootordered_.md b/docs/trie-hash/modules/_trierootordered_.md index af42648c0..ccc201fd0 100644 --- a/docs/trie-hash/modules/_trierootordered_.md +++ b/docs/trie-hash/modules/_trierootordered_.md @@ -8,7 +8,7 @@ ▸ **trieRootOrdered**(input: *`Array`<`Uint8Array`>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/9f9ceff/packages/trie-hash/src/trieRootOrdered.ts#L30)* +*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-hash/src/trieRootOrdered.ts#L30)* *__name__*: trieRootOrdered diff --git a/docs/trie-hash/modules/_types_.md b/docs/trie-hash/modules/_types_.md index e90032e20..65c019b64 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/9f9ceff/packages/trie-hash/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 880915605..ca1a8828c 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/9f9ceff/packages/trie-hash/src/unhashedTrie.ts#L14)* +*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/2efc5f7/packages/trie-hash/src/unhashedTrie.ts#L14)* **Parameters:** diff --git a/docs/util-crypto/index.html b/docs/util-crypto/index.html index e9fc9bfbb..dacbd4a26 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 d095d6311..a550b4a6f 100644 --- a/docs/util-crypto/modules/_blake2_ashex_.md +++ b/docs/util-crypto/modules/_blake2_ashex_.md @@ -6,9 +6,9 @@ ## blake2AsHex -▸ **blake2AsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string` +▸ **blake2AsHex**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/blake2/asHex.ts#L21)* +*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/blake2/asHex.ts#L21)* *__name__*: blake2AsHex @@ -28,7 +28,7 @@ blake2AsHex('abc'); // => 0xba80a53f981c4d0d | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | `string` | - | +| data | `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 256 | **Returns:** `string` diff --git a/docs/util-crypto/modules/_blake2_asu8a_.md b/docs/util-crypto/modules/_blake2_asu8a_.md index fa2b45c5a..b721e16d4 100644 --- a/docs/util-crypto/modules/_blake2_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_asu8a_.md @@ -6,9 +6,9 @@ ## blake2AsU8a -▸ **blake2AsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array` +▸ **blake2AsU8a**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array` -*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/blake2/asU8a.ts#L21)* +*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/blake2/asU8a.ts#L21)* *__name__*: blake2AsU8a @@ -28,7 +28,7 @@ blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d] | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | `string` | - | +| data | `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 256 | | `Optional` key | `Uint8Array` | - | diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md index 2ac8f9ad5..e78475cf2 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md @@ -6,9 +6,9 @@ ## blake2bAsHex -▸ **blake2bAsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string` +▸ **blake2bAsHex**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* +*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* *__name__*: blake2bAsHex @@ -28,7 +28,7 @@ blake2bAsHex('abc'); // => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | `string` | - | +| data | `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 512 | **Returns:** `string` diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md index 1c0f65c81..73bfe2826 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md @@ -6,9 +6,9 @@ ## blake2bAsU8a -▸ **blake2bAsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array` | `null`*): `Uint8Array` +▸ **blake2bAsU8a**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*, key?: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* +*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* *__name__*: blake2bAsU8a @@ -28,9 +28,9 @@ blake2bAsU8a('abc'); // => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209 | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Uint8Array` | `string` | - | +| data | `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 512 | -| `Default value` key | `Uint8Array` | `null` | null | +| `Default value` key | `Uint8Array` \| `null` | null | **Returns:** `Uint8Array` diff --git a/docs/util-crypto/modules/_index_.md b/docs/util-crypto/modules/_index_.md index cdc57c828..d406d8405 100644 --- a/docs/util-crypto/modules/_index_.md +++ b/docs/util-crypto/modules/_index_.md @@ -8,7 +8,7 @@ ▸ **cryptoWaitReady**(): `Promise`<`boolean`> -*Defined in [index.ts:16](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/index.ts#L16)* +*Defined in [index.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/index.ts#L16)* **Returns:** `Promise`<`boolean`> diff --git a/docs/util-crypto/modules/_keccak_ashex_.md b/docs/util-crypto/modules/_keccak_ashex_.md index ca558d950..452d967b2 100644 --- a/docs/util-crypto/modules/_keccak_ashex_.md +++ b/docs/util-crypto/modules/_keccak_ashex_.md @@ -6,9 +6,9 @@ ## keccakAsHex -▸ **keccakAsHex**(value: *`Buffer` | `Uint8Array` | `string`*): `string` +▸ **keccakAsHex**(value: *`Buffer` \| `Uint8Array` \| `string`*): `string` -*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/keccak/asHex.ts#L23)* +*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/keccak/asHex.ts#L23)* *__name__*: keccakAsHex @@ -28,7 +28,7 @@ keccakAsHex('123'); // => 0x... | Name | Type | | ------ | ------ | -| value | `Buffer` | `Uint8Array` | `string` | +| value | `Buffer` \| `Uint8Array` \| `string` | **Returns:** `string` diff --git a/docs/util-crypto/modules/_keccak_asu8a_.md b/docs/util-crypto/modules/_keccak_asu8a_.md index e88edde3a..f79587696 100644 --- a/docs/util-crypto/modules/_keccak_asu8a_.md +++ b/docs/util-crypto/modules/_keccak_asu8a_.md @@ -6,9 +6,9 @@ ## keccakAsU8a -▸ **keccakAsU8a**(value: *`Buffer` | `Uint8Array` | `string`*): `Uint8Array` +▸ **keccakAsU8a**(value: *`Buffer` \| `Uint8Array` \| `string`*): `Uint8Array` -*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/keccak/asU8a.ts#L21)* +*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/keccak/asU8a.ts#L21)* *__name__*: keccakAsU8a @@ -28,7 +28,7 @@ keccakAsU8a('123'); // => Uint8Array | Name | Type | | ------ | ------ | -| value | `Buffer` | `Uint8Array` | `string` | +| value | `Buffer` \| `Uint8Array` \| `string` | **Returns:** `Uint8Array` diff --git a/docs/util-crypto/modules/_mnemonic_generate_.md b/docs/util-crypto/modules/_mnemonic_generate_.md index 04b88d33a..a8bef2f67 100644 --- a/docs/util-crypto/modules/_mnemonic_generate_.md +++ b/docs/util-crypto/modules/_mnemonic_generate_.md @@ -8,7 +8,7 @@ ▸ **mnemonicGenerate**(): `string` -*Defined in [mnemonic/generate.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/mnemonic/generate.ts#L19)* +*Defined in [mnemonic/generate.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/mnemonic/generate.ts#L19)* *__name__*: mnemonicGenerate diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_.md b/docs/util-crypto/modules/_mnemonic_tosecret_.md index 63be0bb69..b9d06e308 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/9f9ceff/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* +*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* **Parameters:** diff --git a/docs/util-crypto/modules/_mnemonic_toseed_.md b/docs/util-crypto/modules/_mnemonic_toseed_.md index 412c81a91..d85d2c846 100644 --- a/docs/util-crypto/modules/_mnemonic_toseed_.md +++ b/docs/util-crypto/modules/_mnemonic_toseed_.md @@ -8,7 +8,7 @@ ▸ **toSeed**(mnemonic: *`string`*): `Uint8Array` -*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* +*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* *__name__*: toSeed diff --git a/docs/util-crypto/modules/_mnemonic_validate_.md b/docs/util-crypto/modules/_mnemonic_validate_.md index e35206ae1..5b7aa5a9f 100644 --- a/docs/util-crypto/modules/_mnemonic_validate_.md +++ b/docs/util-crypto/modules/_mnemonic_validate_.md @@ -8,7 +8,7 @@ ▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean` -*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/mnemonic/validate.ts#L20)* +*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/mnemonic/validate.ts#L20)* *__name__*: mnemonicValidate diff --git a/docs/util-crypto/modules/_nacl_decrypt_.md b/docs/util-crypto/modules/_nacl_decrypt_.md index 4334aadab..6152f5759 100644 --- a/docs/util-crypto/modules/_nacl_decrypt_.md +++ b/docs/util-crypto/modules/_nacl_decrypt_.md @@ -6,9 +6,9 @@ ## naclDecrypt -▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` | `null` +▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` \| `null` -*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/decrypt.ts#L21)* +*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/decrypt.ts#L21)* *__name__*: naclDecrypt @@ -32,7 +32,7 @@ naclDecrypt([...], [...], [...]); // => [...] | nonce | `Uint8Array` | | secret | `Uint8Array` | -**Returns:** `Uint8Array` | `null` +**Returns:** `Uint8Array` \| `null` ___ diff --git a/docs/util-crypto/modules/_nacl_encrypt_.md b/docs/util-crypto/modules/_nacl_encrypt_.md index f4d5035b3..161e3faff 100644 --- a/docs/util-crypto/modules/_nacl_encrypt_.md +++ b/docs/util-crypto/modules/_nacl_encrypt_.md @@ -8,7 +8,7 @@ ▸ **naclEncrypt**(message: *`Uint8Array`*, secret: *`Uint8Array`*, nonce?: *`Uint8Array`*): `Encrypted` -*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/encrypt.ts#L28)* +*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/encrypt.ts#L28)* *__name__*: naclEncrypt diff --git a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md index e23bb1b24..1a9e970db 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromRandom**(): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* +*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* *__name__*: naclKeypairFromRandom diff --git a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md index 1c8f45c8a..ecb2a2d45 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromSecret**(secret: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* +*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* *__name__*: naclKeypairFromSecret diff --git a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md index 428a582a7..e3108a1ef 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* +*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* *__name__*: naclKeypairFromSeed diff --git a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md index c8a898f15..72d8bd4b8 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromString**(value: *`string`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* +*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* *__name__*: naclKeypairFromString diff --git a/docs/util-crypto/modules/_nacl_sign_.md b/docs/util-crypto/modules/_nacl_sign_.md index b6cd91ba2..755b4f2d6 100644 --- a/docs/util-crypto/modules/_nacl_sign_.md +++ b/docs/util-crypto/modules/_nacl_sign_.md @@ -8,7 +8,7 @@ ▸ **naclSign**(message: *`Uint8Array`*, __namedParameters: *`object`*): `Uint8Array` -*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/sign.ts#L24)* +*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/sign.ts#L24)* *__name__*: naclSign diff --git a/docs/util-crypto/modules/_nacl_verify_.md b/docs/util-crypto/modules/_nacl_verify_.md index fcbd4eab7..43fbfb057 100644 --- a/docs/util-crypto/modules/_nacl_verify_.md +++ b/docs/util-crypto/modules/_nacl_verify_.md @@ -8,7 +8,7 @@ ▸ **naclVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean` -*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/nacl/verify.ts#L21)* +*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/nacl/verify.ts#L21)* *__name__*: naclSign diff --git a/docs/util-crypto/modules/_random_ashex_.md b/docs/util-crypto/modules/_random_ashex_.md index 4e75817c6..5a8e9d1b8 100644 --- a/docs/util-crypto/modules/_random_ashex_.md +++ b/docs/util-crypto/modules/_random_ashex_.md @@ -8,7 +8,7 @@ ▸ **randomAsHex**(length?: *`number`*): `string` -*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/random/asHex.ts#L23)* +*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/random/asHex.ts#L23)* *__name__*: randomAsHex diff --git a/docs/util-crypto/modules/_random_asnumber_.md b/docs/util-crypto/modules/_random_asnumber_.md index 4b8af54e3..1dacf247e 100644 --- a/docs/util-crypto/modules/_random_asnumber_.md +++ b/docs/util-crypto/modules/_random_asnumber_.md @@ -8,7 +8,7 @@ ▸ **randomAsNumber**(): `number` -*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/random/asNumber.ts#L26)* +*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/random/asNumber.ts#L26)* *__name__*: randomAsNumber diff --git a/docs/util-crypto/modules/_random_asu8a_.md b/docs/util-crypto/modules/_random_asu8a_.md index ed5153087..69e6a65d6 100644 --- a/docs/util-crypto/modules/_random_asu8a_.md +++ b/docs/util-crypto/modules/_random_asu8a_.md @@ -8,7 +8,7 @@ ▸ **randomAsU8a**(length?: *`number`*): `Uint8Array` -*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/random/asU8a.ts#L21)* +*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/random/asU8a.ts#L21)* *__name__*: randomAsU8a diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md index 330502c53..26e5bd0c2 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/9f9ceff/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* +*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* *__name__*: schnorrkelKeypairFromSeed diff --git a/docs/util-crypto/modules/_schnorrkel_ready_.md b/docs/util-crypto/modules/_schnorrkel_ready_.md index cf0b40f98..74b2b0936 100644 --- a/docs/util-crypto/modules/_schnorrkel_ready_.md +++ b/docs/util-crypto/modules/_schnorrkel_ready_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelIsReady**(): `boolean` -*Defined in [schnorrkel/ready.ts:11](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/schnorrkel/ready.ts#L11)* +*Defined in [schnorrkel/ready.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/schnorrkel/ready.ts#L11)* **Returns:** `boolean` @@ -19,7 +19,7 @@ ___ ▸ **schnorrkelWaitReady**(): `Promise`<`boolean`> -*Defined in [schnorrkel/ready.ts:7](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/schnorrkel/ready.ts#L7)* +*Defined in [schnorrkel/ready.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/schnorrkel/ready.ts#L7)* **Returns:** `Promise`<`boolean`> diff --git a/docs/util-crypto/modules/_schnorrkel_sign_.md b/docs/util-crypto/modules/_schnorrkel_sign_.md index 4c1e681fb..9101d8974 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/9f9ceff/packages/util-crypto/src/schnorrkel/sign.ts#L15)* +*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/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 623f6f5af..a48884255 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/9f9ceff/packages/util-crypto/src/schnorrkel/verify.ts#L11)* +*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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 11f51a6cd..af24fb958 100644 --- a/docs/util-crypto/modules/_sha512_asu8a_.md +++ b/docs/util-crypto/modules/_sha512_asu8a_.md @@ -8,7 +8,7 @@ ▸ **sha512AsU8a**(data: *`Uint8Array`*): `Uint8Array` -*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/sha512/asU8a.ts#L21)* +*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/sha512/asU8a.ts#L21)* *__name__*: sha512AsU8a diff --git a/docs/util-crypto/modules/_types_.md b/docs/util-crypto/modules/_types_.md index df28f5569..29e5d5bf0 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/9f9ceff/packages/util-crypto/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 92db2aa2d..bad628956 100644 --- a/docs/util-crypto/modules/_xxhash_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_ashex_.md @@ -6,9 +6,9 @@ ## xxhashAsHex -▸ **xxhashAsHex**(data: *`Buffer` | `Uint8Array` | `string`*, bitLength?: *`number`*): `string` +▸ **xxhashAsHex**(data: *`Buffer` \| `Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/asHex.ts#L23)* +*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/asHex.ts#L23)* *__name__*: xxhashAsHex @@ -28,7 +28,7 @@ xxhashAsHex('abc'); // => 0x44bc2cf5ad770999 | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | - | +| data | `Buffer` \| `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 64 | **Returns:** `string` diff --git a/docs/util-crypto/modules/_xxhash_asu8a_.md b/docs/util-crypto/modules/_xxhash_asu8a_.md index d7888f156..e4c20850c 100644 --- a/docs/util-crypto/modules/_xxhash_asu8a_.md +++ b/docs/util-crypto/modules/_xxhash_asu8a_.md @@ -6,9 +6,9 @@ ## xxhashAsU8a -▸ **xxhashAsU8a**(data: *`Buffer` | `Uint8Array` | `string`*, bitLength?: *`number`*): `Uint8Array` +▸ **xxhashAsU8a**(data: *`Buffer` \| `Uint8Array` \| `string`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/asU8a.ts#L21)* +*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/asU8a.ts#L21)* *__name__*: xxhashAsU8a @@ -28,7 +28,7 @@ xxhashAsU8a('abc'); // => 0x44bc2cf5ad770999 | Name | Type | Default value | | ------ | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | - | +| data | `Buffer` \| `Uint8Array` \| `string` | - | | `Default value` bitLength | `number` | 64 | **Returns:** `Uint8Array` diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md index a75670cf0..9fc80edb9 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md @@ -6,9 +6,9 @@ ## xxhash64AsBn -▸ **xxhash64AsBn**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `BN` +▸ **xxhash64AsBn**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `BN` -*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* +*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* *__name__*: xxhash64AsBn @@ -28,7 +28,7 @@ xxhash64AsBn('abcd', 0xabcd)); // => new BN(0xe29f70f8b8c96df7) | Name | Type | | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | +| data | `Buffer` \| `Uint8Array` \| `string` | | seed | `number` | **Returns:** `BN` diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md index 93e63e124..f8c733028 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md @@ -6,9 +6,9 @@ ## xxhash64AsHex -▸ **xxhash64AsHex**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `string` +▸ **xxhash64AsHex**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* +*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* *__name__*: xxhash64AsHex @@ -28,7 +28,7 @@ xxhash64AsHex('abcd', 0xabcd)); // => 0xe29f70f8b8c96df7 | Name | Type | | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | +| data | `Buffer` \| `Uint8Array` \| `string` | | seed | `number` | **Returns:** `string` diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md index 94e2447a5..469b8050f 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md @@ -6,9 +6,9 @@ ## xxhash64AsRaw -▸ **xxhash64AsRaw**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `string` +▸ **xxhash64AsRaw**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* +*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* *__name__*: xxhash64AsRaw @@ -28,7 +28,7 @@ xxhash64AsRaw('abcd', 0xabcd)); // => e29f70f8b8c96df7 | Name | Type | | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | +| data | `Buffer` \| `Uint8Array` \| `string` | | seed | `number` | **Returns:** `string` diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md index 32384a169..8b97f7fe4 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md @@ -6,9 +6,9 @@ ## xxhash64AsValue -▸ **xxhash64AsValue**(data: *`Buffer` | `Uint8Array` | `string`*, seed: *`number`*): `number` +▸ **xxhash64AsValue**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `number` -*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* +*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* *__name__*: xxhash64AsValue @@ -28,7 +28,7 @@ xxhash64AsValue('abcd', 0xabcd)); // => e29f70f8b8c96df7 | Name | Type | | ------ | ------ | -| data | `Buffer` | `Uint8Array` | `string` | +| data | `Buffer` \| `Uint8Array` \| `string` | | seed | `number` | **Returns:** `number` diff --git a/docs/util-rlp/modules/_decoder_decode_.md b/docs/util-rlp/modules/_decoder_decode_.md index 2a0ab787b..6d183cdd8 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/9f9ceff/packages/util-rlp/src/decoder/decode.ts#L28)* +*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/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 db2b9c75a..d2116560f 100644 --- a/docs/util-rlp/modules/_decoder_index_.md +++ b/docs/util-rlp/modules/_decoder_index_.md @@ -6,9 +6,9 @@ ## decoder -▸ **decoder**(input?: *`null` | `Uint8Array`*): `Uint8Array` | `Array`<`any`> +▸ **decoder**(input?: *`null` \| `Uint8Array`*): `Uint8Array` \| `Array`<`any`> -*Defined in [decoder/index.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-rlp/src/decoder/index.ts#L23)* +*Defined in [decoder/index.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/decoder/index.ts#L23)* *__name__*: decoder @@ -28,9 +28,9 @@ decode(new Uint8Array([0x83, 0x64, 0x6f, 0x67])); // => 'dog' as Uint8Array | Name | Type | | ------ | ------ | -| `Optional` input | `null` | `Uint8Array` | +| `Optional` input | `null` \| `Uint8Array` | -**Returns:** `Uint8Array` | `Array`<`any`> +**Returns:** `Uint8Array` \| `Array`<`any`> ___ diff --git a/docs/util-rlp/modules/_decoder_listlong_.md b/docs/util-rlp/modules/_decoder_listlong_.md index 3e4a0dd04..4a77e6270 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/9f9ceff/packages/util-rlp/src/decoder/listLong.ts#L11)* +*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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 1980c72bf..ab6d9667b 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/9f9ceff/packages/util-rlp/src/decoder/listShort.ts#L7)* +*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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 9315e3ca2..71f51c9f5 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/9f9ceff/packages/util-rlp/src/decoder/number.ts#L11)* +*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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 a6554e6a4..d5dbf72c7 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/9f9ceff/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* +*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_single_.md b/docs/util-rlp/modules/_decoder_single_.md index 77be5ec4b..b41e52ebe 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/9f9ceff/packages/util-rlp/src/decoder/single.ts#L7)* +*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/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 55b52410f..177c94c07 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/9f9ceff/packages/util-rlp/src/decoder/string.ts#L9)* +*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/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 f4a5cae5b..47b2b0177 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/9f9ceff/packages/util-rlp/src/decoder/types.ts#L10)* +*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/util-rlp/src/decoder/types.ts#L5)* +*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/decoder/types.ts#L5)* #### Type declaration diff --git a/docs/util-rlp/modules/_encoder_array_.md b/docs/util-rlp/modules/_encoder_array_.md index b89bcc0fe..626ac9c59 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/9f9ceff/packages/util-rlp/src/encoder/array.ts#L11)* +*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/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 8a1d1059c..b0b8835de 100644 --- a/docs/util-rlp/modules/_encoder_index_.md +++ b/docs/util-rlp/modules/_encoder_index_.md @@ -8,7 +8,7 @@ ▸ **encoder**(input: *`any`*): `Uint8Array` -*Defined in [encoder/index.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-rlp/src/encoder/index.ts#L23)* +*Defined in [encoder/index.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/encoder/index.ts#L23)* *__name__*: encoder diff --git a/docs/util-rlp/modules/_encoder_length_.md b/docs/util-rlp/modules/_encoder_length_.md index 29bfd052c..505e2b94d 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/9f9ceff/packages/util-rlp/src/encoder/length.ts#L7)* +*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/encoder/length.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_tou8a_.md b/docs/util-rlp/modules/_encoder_tou8a_.md index 0e2e1276a..c4d144790 100644 --- a/docs/util-rlp/modules/_encoder_tou8a_.md +++ b/docs/util-rlp/modules/_encoder_tou8a_.md @@ -8,7 +8,7 @@ ▸ **toU8a**(value?: *`any`*): `Uint8Array` -*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util-rlp/src/encoder/toU8a.ts#L39)* +*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/encoder/toU8a.ts#L39)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_types_.md b/docs/util-rlp/modules/_encoder_types_.md index b7f66204b..44782729f 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/9f9ceff/packages/util-rlp/src/encoder/types.ts#L5)* +*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/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 db4814503..eb57b6b16 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/9f9ceff/packages/util-rlp/src/encoder/u8a.ts#L11)* +*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util-rlp/src/encoder/u8a.ts#L11)* **Parameters:** diff --git a/docs/util/classes/_ext_error_.exterror.md b/docs/util/classes/_ext_error_.exterror.md index 98b7192af..1348f9cde 100644 --- a/docs/util/classes/_ext_error_.exterror.md +++ b/docs/util/classes/_ext_error_.exterror.md @@ -32,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:43](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L43)* **Parameters:** @@ -56,7 +56,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[code](../interfaces/_types_.exterrorinterface.md#code)* -*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L35)* +*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L35)* ___ @@ -67,7 +67,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[data](../interfaces/_types_.exterrorinterface.md#data)* -*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L37)* +*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L37)* ___ @@ -80,7 +80,7 @@ ___ *Overrides Error.message* -*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L39)* +*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L39)* ___ @@ -91,7 +91,7 @@ ___ *Overrides Error.name* -*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L41)* +*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L41)* ___ @@ -104,7 +104,7 @@ ___ *Overrides Error.stack* -*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L43)* ___ @@ -113,7 +113,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984* ___ @@ -125,7 +125,7 @@ ___ **CODES**: *`object`* -*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L60)* +*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L60)* @@ -133,7 +133,7 @@ ___ **● ASSERT**: *`number`* = -90009 -*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L61)* +*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L61)* ___ @@ -142,7 +142,7 @@ ___ **● INVALID_JSONRPC**: *`number`* = -99998 -*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L63)* +*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L63)* ___ @@ -151,7 +151,7 @@ ___ **● METHOD_NOT_FOUND**: *`number`* = -32601 -*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L64)* +*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L64)* ___ @@ -160,7 +160,7 @@ ___ **● UNKNOWN**: *`number`* -*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/ext/error.ts#L62)* +*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/ext/error.ts#L62)* ___ diff --git a/docs/util/index.html b/docs/util/index.html index 8aab5c79b..6d6a2a5e5 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 a2bb31a80..c8b6092f1 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/9f9ceff/packages/util/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L6)* ___ @@ -25,7 +25,7 @@ ___ **● data**: *`any`* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L7)* ___ @@ -34,7 +34,7 @@ ___ **● message**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L8)* ___ @@ -43,7 +43,7 @@ ___ **● stack**: *`string`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L9)* ___ diff --git a/docs/util/interfaces/_types_.tobnoptions.md b/docs/util/interfaces/_types_.tobnoptions.md index 4100f423c..6eb128656 100644 --- a/docs/util/interfaces/_types_.tobnoptions.md +++ b/docs/util/interfaces/_types_.tobnoptions.md @@ -10,18 +10,18 @@ ## `` isLe -**● isLe**: *`undefined` | `false` | `true`* +**● isLe**: *`undefined` \| `false` \| `true`* -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L24)* ___ ## `` isNegative -**● isNegative**: *`undefined` | `false` | `true`* +**● isNegative**: *`undefined` \| `false` \| `true`* -*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L25)* ___ diff --git a/docs/util/modules/_array_filter_.md b/docs/util/modules/_array_filter_.md index 877faad9f..d361dba08 100644 --- a/docs/util/modules/_array_filter_.md +++ b/docs/util/modules/_array_filter_.md @@ -8,7 +8,7 @@ ▸ **arrayFilter**(array: *`Array`<`any`>*, allowNulls?: *`boolean`*): `Array`<`any`> -*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/array/filter.ts#L23)* +*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/array/filter.ts#L23)* *__name__*: arrayFilter diff --git a/docs/util/modules/_assert_.md b/docs/util/modules/_assert_.md index 4c29c9a2a..a0f9061ce 100644 --- a/docs/util/modules/_assert_.md +++ b/docs/util/modules/_assert_.md @@ -6,9 +6,9 @@ ## assert -▸ **assert**<`T`>(test: *`Falsy` | `T`*, 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:28](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/assert.ts#L28)* +*Defined in [assert.ts:28](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/assert.ts#L28)* *__name__*: assert @@ -33,8 +33,8 @@ assert(false, () => 'message'); // ExtError with 'message' | Name | Type | Default value | | ------ | ------ | ------ | -| test | `Falsy` | `T` | - | -| message | `string` | `MessageFn` | - | +| test | `Falsy` \| `T` | - | +| message | `string` \| `MessageFn` | - | | `Default value` code | `number` | ExtError.CODES.ASSERT | | `Optional` data | `any` | - | diff --git a/docs/util/modules/_bn_tobn_.md b/docs/util/modules/_bn_tobn_.md index 5958986b2..c21cdba5d 100644 --- a/docs/util/modules/_bn_tobn_.md +++ b/docs/util/modules/_bn_tobn_.md @@ -6,9 +6,9 @@ ## bnToBn -▸ **bnToBn**(value?: *`BN` | `number` | `null`*): `BN` +▸ **bnToBn**(value?: *`BN` \| `number` \| `null`*): `BN` -*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/bn/toBn.ts#L23)* +*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/bn/toBn.ts#L23)* *__name__*: bnToBn @@ -30,7 +30,7 @@ bnToBn(new BN(0x1234)); // => BN(0x1234) | Name | Type | | ------ | ------ | -| `Optional` value | `BN` | `number` | `null` | +| `Optional` value | `BN` \| `number` \| `null` | **Returns:** `BN` diff --git a/docs/util/modules/_bn_tohex_.md b/docs/util/modules/_bn_tohex_.md index 647c21b0b..b692f44b3 100644 --- a/docs/util/modules/_bn_tohex_.md +++ b/docs/util/modules/_bn_tohex_.md @@ -6,9 +6,9 @@ ## bnToHex -▸ **bnToHex**(value?: *`BN` | `number` | `null`*, options?: *`number` | `Options`*): `string` +▸ **bnToHex**(value?: *`BN` \| `number` \| `null`*, options?: *`number` \| `Options`*): `string` -*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/bn/toHex.ts#L33)* +*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/bn/toHex.ts#L33)* *__name__*: bnToHex @@ -29,8 +29,8 @@ bnToHex(new BN(0x123456)); // => '0x123456' | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `BN` | `number` | `null` | - | -| `Default value` options | `number` | `Options` | { bitLength: -1, isLe: false, isNegative: false } | +| `Optional` value | `BN` \| `number` \| `null` | - | +| `Default value` options | `number` \| `Options` | { bitLength: -1, isLe: false, isNegative: false } | **Returns:** `string` diff --git a/docs/util/modules/_bn_tou8a_.md b/docs/util/modules/_bn_tou8a_.md index 283d1c288..8232a0b0a 100644 --- a/docs/util/modules/_bn_tou8a_.md +++ b/docs/util/modules/_bn_tou8a_.md @@ -6,11 +6,11 @@ ## bnToU8a -▸ **bnToU8a**(value: *`BN` | `number` | `null`*, options?: *`Options`*): `Uint8Array` +▸ **bnToU8a**(value: *`BN` \| `number` \| `null`*, options?: *`Options`*): `Uint8Array` -▸ **bnToU8a**(value: *`BN` | `number` | `null`*, bitLength?: *`undefined` | `number`*, isLe?: *`undefined` | `false` | `true`*): `Uint8Array` +▸ **bnToU8a**(value: *`BN` \| `number` \| `null`*, bitLength?: *`undefined` \| `number`*, isLe?: *`undefined` \| `false` \| `true`*): `Uint8Array` -*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/bn/toU8a.ts#L29)* +*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/bn/toU8a.ts#L29)* *__name__*: bnToU8a @@ -30,20 +30,20 @@ bnToU8a(new BN(0x1234)); // => [0x12, 0x34] | Name | Type | | ------ | ------ | -| value | `BN` | `number` | `null` | +| value | `BN` \| `number` \| `null` | | `Optional` options | `Options` | **Returns:** `Uint8Array` -*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/bn/toU8a.ts#L30)* +*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/bn/toU8a.ts#L30)* **Parameters:** | Name | Type | | ------ | ------ | -| value | `BN` | `number` | `null` | -| `Optional` bitLength | `undefined` | `number` | -| `Optional` isLe | `undefined` | `false` | `true` | +| value | `BN` \| `number` \| `null` | +| `Optional` bitLength | `undefined` \| `number` | +| `Optional` isLe | `undefined` \| `false` \| `true` | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_buffer_tou8a_.md b/docs/util/modules/_buffer_tou8a_.md index e6846dbad..4af6b09dd 100644 --- a/docs/util/modules/_buffer_tou8a_.md +++ b/docs/util/modules/_buffer_tou8a_.md @@ -6,9 +6,9 @@ ## bufferToU8a -▸ **bufferToU8a**(buffer?: *`Buffer` | `number`[] | `null`*): `Uint8Array` +▸ **bufferToU8a**(buffer?: *`Buffer` \| `number`[] \| `null`*): `Uint8Array` -*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/buffer/toU8a.ts#L19)* +*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/buffer/toU8a.ts#L19)* *__name__*: bufferToU8a @@ -28,7 +28,7 @@ bufferToU8a(Buffer.from([1, 2, 3])); | Name | Type | | ------ | ------ | -| `Optional` buffer | `Buffer` | `number`[] | `null` | +| `Optional` buffer | `Buffer` \| `number`[] \| `null` | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_compact_addlength_.md b/docs/util/modules/_compact_addlength_.md index 197e81b26..b707fd6de 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/9f9ceff/packages/util/src/compact/addLength.ts#L20)* +*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/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 bdc6f75c8..d62c58eea 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/9f9ceff/packages/util/src/compact/defaults.ts#L7)* +*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/compact/defaults.ts#L7)* ___ diff --git a/docs/util/modules/_compact_fromu8a_.md b/docs/util/modules/_compact_fromu8a_.md index a5becadb8..99b3eb5f4 100644 --- a/docs/util/modules/_compact_fromu8a_.md +++ b/docs/util/modules/_compact_fromu8a_.md @@ -6,9 +6,9 @@ ## compactFromU8a -▸ **compactFromU8a**(_input: *`Uint8Array` | `string`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `BN`] +▸ **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/9f9ceff/packages/util/src/compact/fromU8a.ts#L26)* +*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/compact/fromU8a.ts#L26)* *__name__*: compactFromU8a @@ -28,7 +28,7 @@ console.log('value offset=', offset, 'length=', length); // 4, 0xffff | Name | Type | Default value | | ------ | ------ | ------ | -| _input | `Uint8Array` | `string` | - | +| _input | `Uint8Array` \| `string` | - | | `Default value` bitLength | [BitLength](_compact_types_.md#bitlength) | DEFAULT_BITLENGTH | **Returns:** [`number`, `BN`] diff --git a/docs/util/modules/_compact_striplength_.md b/docs/util/modules/_compact_striplength_.md index 4fbd18957..c46c8ed1a 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/9f9ceff/packages/util/src/compact/stripLength.ts#L22)* +*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/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 466ddfaf2..dd0d764bd 100644 --- a/docs/util/modules/_compact_tou8a_.md +++ b/docs/util/modules/_compact_tou8a_.md @@ -6,9 +6,9 @@ ## compactToU8a -▸ **compactToU8a**(_value: *`BN` | `number`*): `Uint8Array` +▸ **compactToU8a**(_value: *`BN` \| `number`*): `Uint8Array` -*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/compact/toU8a.ts#L27)* +*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/compact/toU8a.ts#L27)* *__name__*: compactToU8a @@ -26,7 +26,7 @@ console.log(compactToU8a(511, 32)); // Uint8Array([0b11111101, 0b00000111]) | Name | Type | | ------ | ------ | -| _value | `BN` | `number` | +| _value | `BN` \| `number` | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_compact_types_.md b/docs/util/modules/_compact_types_.md index b5e88859b..00524ec8b 100644 --- a/docs/util/modules/_compact_types_.md +++ b/docs/util/modules/_compact_types_.md @@ -6,9 +6,9 @@ ## BitLength -**Ƭ BitLength**: *`8` | `16` | `32` | `64` | `128` | `256`* +**Ƭ BitLength**: *`8` \| `16` \| `32` \| `64` \| `128` \| `256`* -*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/compact/types.ts#L5)* +*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/compact/types.ts#L5)* ___ diff --git a/docs/util/modules/_hex_addprefix_.md b/docs/util/modules/_hex_addprefix_.md index eb2cdeae8..30a3b60fc 100644 --- a/docs/util/modules/_hex_addprefix_.md +++ b/docs/util/modules/_hex_addprefix_.md @@ -6,9 +6,9 @@ ## hexAddPrefix -▸ **hexAddPrefix**(value?: *`string` | `null`*): `string` +▸ **hexAddPrefix**(value?: *`string` \| `null`*): `string` -*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/addPrefix.ts#L21)* +*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/addPrefix.ts#L21)* *__name__*: hexAddPrefix @@ -28,7 +28,7 @@ console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12 | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `string` diff --git a/docs/util/modules/_hex_fixlength_.md b/docs/util/modules/_hex_fixlength_.md index 37e307ff9..6170a188b 100644 --- a/docs/util/modules/_hex_fixlength_.md +++ b/docs/util/modules/_hex_fixlength_.md @@ -8,7 +8,7 @@ ▸ **hexFixLength**(value: *`string`*, bitLength?: *`number`*, withPadding?: *`boolean`*): `string` -*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/fixLength.ts#L24)* +*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/fixLength.ts#L24)* *__name__*: hexFixLength diff --git a/docs/util/modules/_hex_hasprefix_.md b/docs/util/modules/_hex_hasprefix_.md index 31e483e0c..8a1fd67b9 100644 --- a/docs/util/modules/_hex_hasprefix_.md +++ b/docs/util/modules/_hex_hasprefix_.md @@ -6,9 +6,9 @@ ## hexHasPrefix -▸ **hexHasPrefix**(value?: *`string` | `null`*): `boolean` +▸ **hexHasPrefix**(value?: *`string` \| `null`*): `boolean` -*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/hasPrefix.ts#L21)* +*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/hasPrefix.ts#L21)* *__name__*: hexHasPrefix @@ -28,7 +28,7 @@ console.log('has prefix', hexHasPrefix('0x1234')); // => true | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `boolean` diff --git a/docs/util/modules/_hex_stripprefix_.md b/docs/util/modules/_hex_stripprefix_.md index b28792002..8ba16f76e 100644 --- a/docs/util/modules/_hex_stripprefix_.md +++ b/docs/util/modules/_hex_stripprefix_.md @@ -6,9 +6,9 @@ ## hexStripPrefix -▸ **hexStripPrefix**(value?: *`string` | `null`*): `string` +▸ **hexStripPrefix**(value?: *`string` \| `null`*): `string` -*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/stripPrefix.ts#L23)* +*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/stripPrefix.ts#L23)* *__name__*: hexStripPrefix @@ -28,7 +28,7 @@ console.log('stripped', hexStripPrefix('0x1234')); // => 1234 | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `string` diff --git a/docs/util/modules/_hex_tobn_.md b/docs/util/modules/_hex_tobn_.md index b1d345cfd..c57d21bdf 100644 --- a/docs/util/modules/_hex_tobn_.md +++ b/docs/util/modules/_hex_tobn_.md @@ -6,9 +6,9 @@ ## hexToBn -▸ **hexToBn**(value?: *`string` | `number` | `null`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean`*): `BN` +▸ **hexToBn**(value?: *`string` \| `number` \| `null`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean`*): `BN` -*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/toBn.ts#L35)* +*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/toBn.ts#L35)* *__name__*: hexToBn @@ -28,8 +28,8 @@ hexToBn('0x123480001f'); // => BN(0x123480001f) | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `string` | `number` | `null` | - | -| `Default value` options | [ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean` | { isLe: false, isNegative: false } | +| `Optional` value | `string` \| `number` \| `null` | - | +| `Default value` options | [ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean` | { isLe: false, isNegative: false } | **Returns:** `BN` diff --git a/docs/util/modules/_hex_tonumber_.md b/docs/util/modules/_hex_tonumber_.md index 0b072a361..5f2d0e93b 100644 --- a/docs/util/modules/_hex_tonumber_.md +++ b/docs/util/modules/_hex_tonumber_.md @@ -6,9 +6,9 @@ ## hexToNumber -▸ **hexToNumber**(value?: *`string` | `null`*): `number` +▸ **hexToNumber**(value?: *`string` \| `null`*): `number` -*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/toNumber.ts#L21)* +*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/toNumber.ts#L21)* *__name__*: hexToNumber @@ -28,7 +28,7 @@ hexToNumber('0x1234'); // => 0x1234 | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `number` diff --git a/docs/util/modules/_hex_tou8a_.md b/docs/util/modules/_hex_tou8a_.md index d9c129cac..fffe58480 100644 --- a/docs/util/modules/_hex_tou8a_.md +++ b/docs/util/modules/_hex_tou8a_.md @@ -6,9 +6,9 @@ ## hexToU8a -▸ **hexToU8a**(_value?: *`string` | `null`*, bitLength?: *`number`*): `Uint8Array` +▸ **hexToU8a**(_value?: *`string` \| `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/hex/toU8a.ts#L24)* +*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/hex/toU8a.ts#L24)* *__name__*: hexToU8a @@ -29,7 +29,7 @@ hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f]) | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` _value | `string` | `null` | - | +| `Optional` _value | `string` \| `null` | - | | `Default value` bitLength | `number` | -1 | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_is_bn_.md b/docs/util/modules/_is_bn_.md index c08e4baba..67307587b 100644 --- a/docs/util/modules/_is_bn_.md +++ b/docs/util/modules/_is_bn_.md @@ -8,7 +8,7 @@ ▸ **isBn**(value: *`any`*): `boolean` -*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/bn.ts#L22)* +*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/bn.ts#L22)* *__name__*: isBn diff --git a/docs/util/modules/_is_boolean_.md b/docs/util/modules/_is_boolean_.md index cc4e061f9..f6c91441e 100644 --- a/docs/util/modules/_is_boolean_.md +++ b/docs/util/modules/_is_boolean_.md @@ -8,7 +8,7 @@ ▸ **isBoolean**(value: *`any`*): `boolean` -*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/boolean.ts#L19)* +*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/boolean.ts#L19)* *__name__*: isBoolean diff --git a/docs/util/modules/_is_buffer_.md b/docs/util/modules/_is_buffer_.md index 589f8c593..178263eff 100644 --- a/docs/util/modules/_is_buffer_.md +++ b/docs/util/modules/_is_buffer_.md @@ -8,7 +8,7 @@ ▸ **isBuffer**(value: *`any`*): `boolean` -*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/buffer.ts#L21)* +*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/buffer.ts#L21)* *__name__*: isBuffer diff --git a/docs/util/modules/_is_error_.md b/docs/util/modules/_is_error_.md index d3a58c100..65d57b481 100644 --- a/docs/util/modules/_is_error_.md +++ b/docs/util/modules/_is_error_.md @@ -8,7 +8,7 @@ ▸ **isError**(value: *`any`*): `boolean` -*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/error.ts#L21)* +*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/error.ts#L21)* *__name__*: isError diff --git a/docs/util/modules/_is_function_.md b/docs/util/modules/_is_function_.md index 6976fd039..ca6241782 100644 --- a/docs/util/modules/_is_function_.md +++ b/docs/util/modules/_is_function_.md @@ -8,7 +8,7 @@ ▸ **isFunction**(value: *`any`*): `boolean` -*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/function.ts#L19)* +*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/function.ts#L19)* *__name__*: isFunction diff --git a/docs/util/modules/_is_hex_.md b/docs/util/modules/_is_hex_.md index 595076512..f27ae1e06 100644 --- a/docs/util/modules/_is_hex_.md +++ b/docs/util/modules/_is_hex_.md @@ -8,7 +8,7 @@ ▸ **isHex**(value: *`any`*, bitLength?: *`number`*, ignoreLength?: *`boolean`*): `boolean` -*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/hex.ts#L24)* +*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/hex.ts#L24)* *__name__*: isHex diff --git a/docs/util/modules/_is_instanceof_.md b/docs/util/modules/_is_instanceof_.md index a2ca801e3..b662b3aec 100644 --- a/docs/util/modules/_is_instanceof_.md +++ b/docs/util/modules/_is_instanceof_.md @@ -8,7 +8,7 @@ ▸ **isInstanceOf**(value: *`any`*, clazz: *`any`*): `boolean` -*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/instanceOf.ts#L19)* +*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/instanceOf.ts#L19)* *__name__*: isInstanceOf diff --git a/docs/util/modules/_is_ip_.md b/docs/util/modules/_is_ip_.md index 8e79a9570..6a631c12e 100644 --- a/docs/util/modules/_is_ip_.md +++ b/docs/util/modules/_is_ip_.md @@ -8,7 +8,7 @@ ▸ **isIp**(value: *`string`*, type?: *`IpTypes`*): `boolean` -*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/ip.ts#L26)* +*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/ip.ts#L26)* *__name__*: isIp diff --git a/docs/util/modules/_is_null_.md b/docs/util/modules/_is_null_.md index f50630987..b4089f729 100644 --- a/docs/util/modules/_is_null_.md +++ b/docs/util/modules/_is_null_.md @@ -8,7 +8,7 @@ ▸ **isNull**(value?: *`any`*): `boolean` -*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/null.ts#L19)* +*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/null.ts#L19)* *__name__*: isNull diff --git a/docs/util/modules/_is_number_.md b/docs/util/modules/_is_number_.md index 525342fbc..093637f04 100644 --- a/docs/util/modules/_is_number_.md +++ b/docs/util/modules/_is_number_.md @@ -8,7 +8,7 @@ ▸ **isNumber**(value: *`any`*): `boolean` -*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/number.ts#L19)* +*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/number.ts#L19)* *__name__*: isNumber diff --git a/docs/util/modules/_is_object_.md b/docs/util/modules/_is_object_.md index c69c2d2ad..438b16720 100644 --- a/docs/util/modules/_is_object_.md +++ b/docs/util/modules/_is_object_.md @@ -8,7 +8,7 @@ ▸ **isObject**(value: *`any`*): `boolean` -*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/object.ts#L24)* +*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/object.ts#L24)* *__name__*: isObject diff --git a/docs/util/modules/_is_observable_.md b/docs/util/modules/_is_observable_.md index c30ef88da..4bf419d41 100644 --- a/docs/util/modules/_is_observable_.md +++ b/docs/util/modules/_is_observable_.md @@ -8,7 +8,7 @@ ▸ **isObservable**(value: *`any`*): `boolean` -*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/observable.ts#L26)* +*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/observable.ts#L26)* *__name__*: isBObservable diff --git a/docs/util/modules/_is_string_.md b/docs/util/modules/_is_string_.md index f6b949399..7722c4876 100644 --- a/docs/util/modules/_is_string_.md +++ b/docs/util/modules/_is_string_.md @@ -8,7 +8,7 @@ ▸ **isString**(value: *`any`*): `boolean` -*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/string.ts#L19)* +*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/string.ts#L19)* *__name__*: isString diff --git a/docs/util/modules/_is_u8a_.md b/docs/util/modules/_is_u8a_.md index e212ef07c..e7efc8365 100644 --- a/docs/util/modules/_is_u8a_.md +++ b/docs/util/modules/_is_u8a_.md @@ -8,7 +8,7 @@ ▸ **isU8a**(value?: *`any`*): `boolean` -*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/u8a.ts#L21)* +*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/u8a.ts#L21)* *__name__*: isU8a diff --git a/docs/util/modules/_is_undefined_.md b/docs/util/modules/_is_undefined_.md index d0524d8b8..8c47f7fe9 100644 --- a/docs/util/modules/_is_undefined_.md +++ b/docs/util/modules/_is_undefined_.md @@ -8,7 +8,7 @@ ▸ **isUndefined**(value?: *`any`*): `boolean` -*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/is/undefined.ts#L19)* +*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/is/undefined.ts#L19)* *__name__*: isUndefined diff --git a/docs/util/modules/_logger_.md b/docs/util/modules/_logger_.md index bb0881f78..63eea3ab8 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/9f9ceff/packages/util/src/logger.ts#L42)* +*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/logger.ts#L42)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **logger**(_type: *`string`*): [Logger](_types_.md#logger) -*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/logger.ts#L104)* +*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/logger.ts#L104)* *__name__*: Logger diff --git a/docs/util/modules/_number_tohex_.md b/docs/util/modules/_number_tohex_.md index 7c7ef1aca..3d09d9229 100644 --- a/docs/util/modules/_number_tohex_.md +++ b/docs/util/modules/_number_tohex_.md @@ -6,9 +6,9 @@ ## numberToHex -▸ **numberToHex**(value?: *`number` | `null`*, bitLength?: *`number`*): `string` +▸ **numberToHex**(value?: *`number` \| `null`*, bitLength?: *`number`*): `string` -*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/number/toHex.ts#L24)* +*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/number/toHex.ts#L24)* *__name__*: numberToHex @@ -29,7 +29,7 @@ numberToHex(0x1234, 32); // => 0x00001234 | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `number` | `null` | - | +| `Optional` value | `number` \| `null` | - | | `Default value` bitLength | `number` | -1 | **Returns:** `string` diff --git a/docs/util/modules/_number_tou8a_.md b/docs/util/modules/_number_tou8a_.md index 33fb92bb7..3ac373b58 100644 --- a/docs/util/modules/_number_tou8a_.md +++ b/docs/util/modules/_number_tou8a_.md @@ -6,9 +6,9 @@ ## numberToU8a -▸ **numberToU8a**(value?: *`number` | `null`*, bitLength?: *`number`*): `Uint8Array` +▸ **numberToU8a**(value?: *`number` \| `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/number/toU8a.ts#L22)* +*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/number/toU8a.ts#L22)* *__name__*: numberToU8a @@ -28,7 +28,7 @@ numberToU8a(0x1234); // => [0x12, 0x34] | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `number` | `null` | - | +| `Optional` value | `number` \| `null` | - | | `Default value` bitLength | `number` | -1 | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_promisify_.md b/docs/util/modules/_promisify_.md index a8b4f596e..11c172be3 100644 --- a/docs/util/modules/_promisify_.md +++ b/docs/util/modules/_promisify_.md @@ -8,7 +8,7 @@ ▸ **promisify**(self: *`any`*, fn: *`Function`*, ...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/promisify.ts#L20)* +*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/promisify.ts#L20)* *__name__*: promisify diff --git a/docs/util/modules/_string_lowerfirst_.md b/docs/util/modules/_string_lowerfirst_.md index 97ef44b4e..b9b1ea00a 100644 --- a/docs/util/modules/_string_lowerfirst_.md +++ b/docs/util/modules/_string_lowerfirst_.md @@ -6,9 +6,9 @@ ## stringLowerFirst -▸ **stringLowerFirst**(value?: *`string` | `null`*): `string` +▸ **stringLowerFirst**(value?: *`string` \| `null`*): `string` -*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/string/lowerFirst.ts#L19)* +*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/string/lowerFirst.ts#L19)* *__name__*: stringLowerFirst @@ -28,7 +28,7 @@ stringLowerFirst('ABC'); // => 'aBC' | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `string` diff --git a/docs/util/modules/_string_shorten_.md b/docs/util/modules/_string_shorten_.md index 7a962b918..3b6ecb5ae 100644 --- a/docs/util/modules/_string_shorten_.md +++ b/docs/util/modules/_string_shorten_.md @@ -8,7 +8,7 @@ ▸ **stringShorten**(_value?: *`any`*, prefixLength?: *`number`*): `string` -*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/string/shorten.ts#L19)* +*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/string/shorten.ts#L19)* *__name__*: stringShorten diff --git a/docs/util/modules/_string_tou8a_.md b/docs/util/modules/_string_tou8a_.md index b1d8548ee..8b9b39497 100644 --- a/docs/util/modules/_string_tou8a_.md +++ b/docs/util/modules/_string_tou8a_.md @@ -6,9 +6,9 @@ ## stringToU8a -▸ **stringToU8a**(value?: *`undefined` | `string`*): `Uint8Array` +▸ **stringToU8a**(value?: *`undefined` \| `string`*): `Uint8Array` -*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/string/toU8a.ts#L39)* +*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/string/toU8a.ts#L39)* *__name__*: stringToU8a @@ -28,7 +28,7 @@ stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f] | Name | Type | | ------ | ------ | -| `Optional` value | `undefined` | `string` | +| `Optional` value | `undefined` \| `string` | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_string_upperfirst_.md b/docs/util/modules/_string_upperfirst_.md index 475059a07..3b0a77e93 100644 --- a/docs/util/modules/_string_upperfirst_.md +++ b/docs/util/modules/_string_upperfirst_.md @@ -6,9 +6,9 @@ ## stringUpperFirst -▸ **stringUpperFirst**(value?: *`string` | `null`*): `string` +▸ **stringUpperFirst**(value?: *`string` \| `null`*): `string` -*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/string/upperFirst.ts#L19)* +*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/string/upperFirst.ts#L19)* *__name__*: stringUpperFirst @@ -28,7 +28,7 @@ stringUpperFirst('abc'); // => 'Abc' | Name | Type | | ------ | ------ | -| `Optional` value | `string` | `null` | +| `Optional` value | `string` \| `null` | **Returns:** `string` diff --git a/docs/util/modules/_syncify_.md b/docs/util/modules/_syncify_.md index 9246ffe1a..d31c254cf 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/9f9ceff/packages/util/src/syncify.ts#L11)* +*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/syncify.ts#L11)* **Parameters:** diff --git a/docs/util/modules/_types_.md b/docs/util/modules/_types_.md index 9e713a5fa..a629fc591 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/9f9ceff/packages/util/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L15)* #### Type declaration @@ -31,9 +31,9 @@ ___ ## Logger$Data -**Ƭ Logger$Data**: *`Array`<`any` | `Logger$Data$Fn`>* +**Ƭ Logger$Data**: *`Array`<`any` \| `Logger$Data$Fn`>* -*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/types.ts#L13)* ___ diff --git a/docs/util/modules/_u8a_concat_.md b/docs/util/modules/_u8a_concat_.md index 15ba32f25..f2e1068a6 100644 --- a/docs/util/modules/_u8a_concat_.md +++ b/docs/util/modules/_u8a_concat_.md @@ -6,9 +6,9 @@ ## u8aConcat -▸ **u8aConcat**(..._list: *`Array`<`Uint8Array` | `string`>*): `Uint8Array` +▸ **u8aConcat**(..._list: *`Array`<`Uint8Array` \| `string`>*): `Uint8Array` -*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/concat.ts#L24)* +*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/concat.ts#L24)* *__name__*: u8aConcat @@ -31,7 +31,7 @@ u8aConcat( | Name | Type | | ------ | ------ | -| `Rest` _list | `Array`<`Uint8Array` | `string`> | +| `Rest` _list | `Array`<`Uint8Array` \| `string`> | **Returns:** `Uint8Array` diff --git a/docs/util/modules/_u8a_fixlength_.md b/docs/util/modules/_u8a_fixlength_.md index 770875c0b..ce0f2badd 100644 --- a/docs/util/modules/_u8a_fixlength_.md +++ b/docs/util/modules/_u8a_fixlength_.md @@ -8,7 +8,7 @@ ▸ **u8aFixLength**(value: *`Uint8Array`*, bitLength?: *`number`*, atStart?: *`boolean`*): `Uint8Array` -*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/fixLength.ts#L21)* +*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/fixLength.ts#L21)* *__name__*: u8aFixLength diff --git a/docs/util/modules/_u8a_tobn_.md b/docs/util/modules/_u8a_tobn_.md index 1084ce2ca..2d75f011b 100644 --- a/docs/util/modules/_u8a_tobn_.md +++ b/docs/util/modules/_u8a_tobn_.md @@ -6,9 +6,9 @@ ## u8aToBn -▸ **u8aToBn**(value: *`Uint8Array`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean`*): `BN` +▸ **u8aToBn**(value: *`Uint8Array`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean`*): `BN` -*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/toBn.ts#L29)* +*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/toBn.ts#L29)* *__name__*: u8aToBn @@ -29,7 +29,7 @@ u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f | Name | Type | Default value | Description | | ------ | ------ | ------ | ------ | | value | `Uint8Array` | - | The value to convert | -| `Default value` options | [ToBnOptions](../interfaces/_types_.tobnoptions.md) | `boolean` | { isLe: true, isNegative: false } | Options to pass while converting | +| `Default value` options | [ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean` | { isLe: true, isNegative: false } | Options to pass while converting | **Returns:** `BN` diff --git a/docs/util/modules/_u8a_tobuffer_.md b/docs/util/modules/_u8a_tobuffer_.md index 06c24b4e6..5bf477ed9 100644 --- a/docs/util/modules/_u8a_tobuffer_.md +++ b/docs/util/modules/_u8a_tobuffer_.md @@ -6,9 +6,9 @@ ## u8aToBuffer -▸ **u8aToBuffer**(value?: *`Uint8Array` | `null`*): `Buffer` +▸ **u8aToBuffer**(value?: *`Uint8Array` \| `null`*): `Buffer` -*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/toBuffer.ts#L19)* +*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/toBuffer.ts#L19)* *__name__*: u8aToBuffer @@ -28,7 +28,7 @@ console.log('Buffer', u8aToBuffer('0x123480001f')); | Name | Type | | ------ | ------ | -| `Optional` value | `Uint8Array` | `null` | +| `Optional` value | `Uint8Array` \| `null` | **Returns:** `Buffer` diff --git a/docs/util/modules/_u8a_tohex_.md b/docs/util/modules/_u8a_tohex_.md index 9d58adc5c..2f0a175e2 100644 --- a/docs/util/modules/_u8a_tohex_.md +++ b/docs/util/modules/_u8a_tohex_.md @@ -6,9 +6,9 @@ ## u8aToHex -▸ **u8aToHex**(value?: *`Uint8Array` | `null`*, bitLength?: *`number`*, isPrefixed?: *`boolean`*): `string` +▸ **u8aToHex**(value?: *`Uint8Array` \| `null`*, bitLength?: *`number`*, isPrefixed?: *`boolean`*): `string` -*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/toHex.ts#L21)* +*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/toHex.ts#L21)* *__name__*: u8aToHex @@ -28,7 +28,7 @@ u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f | Name | Type | Default value | | ------ | ------ | ------ | -| `Optional` value | `Uint8Array` | `null` | - | +| `Optional` value | `Uint8Array` \| `null` | - | | `Default value` bitLength | `number` | -1 | | `Default value` isPrefixed | `boolean` | true | diff --git a/docs/util/modules/_u8a_tostring_.md b/docs/util/modules/_u8a_tostring_.md index 6f033e7ab..2981642fe 100644 --- a/docs/util/modules/_u8a_tostring_.md +++ b/docs/util/modules/_u8a_tostring_.md @@ -6,9 +6,9 @@ ## u8aToString -▸ **u8aToString**(value?: *`Uint8Array` | `null`*): `string` +▸ **u8aToString**(value?: *`Uint8Array` \| `null`*): `string` -*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/toString.ts#L35)* +*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/toString.ts#L35)* *__name__*: u8aToString @@ -28,7 +28,7 @@ u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello | Name | Type | | ------ | ------ | -| `Optional` value | `Uint8Array` | `null` | +| `Optional` value | `Uint8Array` \| `null` | **Returns:** `string` diff --git a/docs/util/modules/_u8a_tou8a_.md b/docs/util/modules/_u8a_tou8a_.md index e442dbdfc..07bec68e5 100644 --- a/docs/util/modules/_u8a_tou8a_.md +++ b/docs/util/modules/_u8a_tou8a_.md @@ -6,9 +6,9 @@ ## u8aToU8a -▸ **u8aToU8a**(value?: *`Array`<`number`> | `Buffer` | `Uint8Array` | `string` | `null`*): `Uint8Array` +▸ **u8aToU8a**(value?: *`Array`<`number`> \| `Buffer` \| `Uint8Array` \| `string` \| `null`*): `Uint8Array` -*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/9f9ceff/packages/util/src/u8a/toU8a.ts#L27)* +*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/2efc5f7/packages/util/src/u8a/toU8a.ts#L27)* *__name__*: u8aToU8a @@ -29,7 +29,7 @@ u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34]) | Name | Type | | ------ | ------ | -| `Optional` value | `Array`<`number`> | `Buffer` | `Uint8Array` | `string` | `null` | +| `Optional` value | `Array`<`number`> \| `Buffer` \| `Uint8Array` \| `string` \| `null` | **Returns:** `Uint8Array` diff --git a/lerna.json b/lerna.json index eb3d22948..9400876fe 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.34.12" + "version": "0.34.13" } diff --git a/package.json b/package.json index 9b957e9e4..264802fe9 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.34.12", + "version": "0.34.13", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/chainspec/package.json b/packages/chainspec/package.json index 487470a07..05ce4c840 100644 --- a/packages/chainspec/package.json +++ b/packages/chainspec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/chainspec", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/util": "^0.34.12" + "@polkadot/util": "^0.34.13" } } diff --git a/packages/db/package.json b/packages/db/package.json index fdb5e657e..0135be3a3 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/db", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/trie-hash": "^0.34.12", - "@polkadot/util": "^0.34.12", + "@polkadot/trie-hash": "^0.34.13", + "@polkadot/util": "^0.34.13", "@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 0ddd49254..f9c85c30d 100644 --- a/packages/keyring/package.json +++ b/packages/keyring/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/keyring", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/util": "^0.34.12", - "@polkadot/util-crypto": "^0.34.12", + "@polkadot/util": "^0.34.13", + "@polkadot/util-crypto": "^0.34.13", "@types/bs58": "^4.0.0", "bs58": "^4.0.1" } diff --git a/packages/trie-codec/package.json b/packages/trie-codec/package.json index b3efc0626..e789dadb6 100644 --- a/packages/trie-codec/package.json +++ b/packages/trie-codec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-codec", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/util": "^0.34.12" + "@polkadot/util": "^0.34.13" } } diff --git a/packages/trie-db/package.json b/packages/trie-db/package.json index 8669db687..cdf0055ca 100644 --- a/packages/trie-db/package.json +++ b/packages/trie-db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-db", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/db": "^0.34.12", - "@polkadot/trie-codec": "^0.34.12", - "@polkadot/trie-hash": "^0.34.12", - "@polkadot/util": "^0.34.12", - "@polkadot/util-crypto": "^0.34.12" + "@polkadot/db": "^0.34.13", + "@polkadot/trie-codec": "^0.34.13", + "@polkadot/trie-hash": "^0.34.13", + "@polkadot/util": "^0.34.13", + "@polkadot/util-crypto": "^0.34.13" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.12", - "@polkadot/util-rlp": "^0.34.12", + "@polkadot/chainspec": "^0.34.13", + "@polkadot/util-rlp": "^0.34.13", "ethereumjs-testing": "1.0.4" } } diff --git a/packages/trie-hash/package.json b/packages/trie-hash/package.json index 4799b3d29..393fed5ec 100644 --- a/packages/trie-hash/package.json +++ b/packages/trie-hash/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-hash", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/util": "^0.34.12" + "@polkadot/util": "^0.34.13" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.12" + "@polkadot/chainspec": "^0.34.13" } } diff --git a/packages/util-crypto/package.json b/packages/util-crypto/package.json index f52709328..3c809c770 100644 --- a/packages/util-crypto/package.json +++ b/packages/util-crypto/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-crypto", - "version": "0.34.12", + "version": "0.34.13", "description": "A collection of useful crypto utilities for @polkadot", "main": "index.js", "keywords": [ @@ -30,7 +30,7 @@ "dependencies": { "@babel/runtime": "^7.3.1", "@parity/schnorrkel-js": "^0.1.2", - "@polkadot/util": "^0.34.12", + "@polkadot/util": "^0.34.13", "@types/bip39": "^2.4.2", "@types/webassembly-js-api": "^0.0.2", "@types/xxhashjs": "^0.2.0", diff --git a/packages/util-rlp/package.json b/packages/util-rlp/package.json index 5711e0f43..842391d4e 100644 --- a/packages/util-rlp/package.json +++ b/packages/util-rlp/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-rlp", - "version": "0.34.12", + "version": "0.34.13", "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.3.1", - "@polkadot/util": "^0.34.12" + "@polkadot/util": "^0.34.13" }, "devDependencies": { "ethereumjs-testing": "1.0.4" diff --git a/packages/util/package.json b/packages/util/package.json index f1b71da02..3cc443a9c 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util", - "version": "0.34.12", + "version": "0.34.13", "description": "A collection of useful utilities for @polkadot", "main": "index.js", "keywords": [ diff --git a/yarn.lock b/yarn.lock index bd00e5983..8dfdd9424 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1675,11 +1675,6 @@ ansi-escapes@^3.0.0, ansi-escapes@^3.2.0: resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-3.2.0.tgz#8780b98ff9dbf5638152d1f1fe5c1d7b4442976b" integrity sha512-cBhpre4ma+U0T1oM5fXg7Dy1Jw7zzwv7lt/GoCpr+hDQJoYnKVPLL4dCvSEFMmQurOQvSrwT7SL/DAlhBI97RQ== -ansi-regex@*, ansi-regex@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-4.0.0.tgz#70de791edf021404c3fd615aa89118ae0432e5a9" - integrity sha512-iB5Dda8t/UqpPI/IjsejXu5jOGDrzn41wJyljwPH65VCIbk6+1BzFIMJGFwTNrYXT1CrD+B4l19U7awiQ8rk7w== - ansi-regex@^2.0.0: version "2.1.1" resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df" @@ -1690,6 +1685,11 @@ ansi-regex@^3.0.0, ansi-regex@~3.0.0: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-3.0.0.tgz#ed0317c322064f79466c02966bddb605ab37d998" integrity sha1-7QMXwyIGT3lGbAKWa922Bas32Zg= +ansi-regex@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-4.0.0.tgz#70de791edf021404c3fd615aa89118ae0432e5a9" + integrity sha512-iB5Dda8t/UqpPI/IjsejXu5jOGDrzn41wJyljwPH65VCIbk6+1BzFIMJGFwTNrYXT1CrD+B4l19U7awiQ8rk7w== + ansi-styles@^2.2.1: version "2.2.1" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe" @@ -3111,7 +3111,7 @@ debug@^4.1.0, debug@^4.1.1: dependencies: ms "^2.1.1" -debuglog@*, debuglog@^1.0.1: +debuglog@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492" integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI= @@ -4536,7 +4536,7 @@ import-local@^2.0.0: pkg-dir "^3.0.0" resolve-cwd "^2.0.0" -imurmurhash@*, imurmurhash@^0.1.4: +imurmurhash@^0.1.4: version "0.1.4" resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" integrity sha1-khi5srkoojixPcT7a21XbyMUU+o= @@ -5746,11 +5746,6 @@ lockfile@~1.0.1, lockfile@~1.0.3: dependencies: signal-exit "^3.0.2" -lodash._baseindexof@*: - version "3.1.0" - resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c" - integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw= - lodash._baseuniq@~4.6.0: version "4.6.0" resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8" @@ -5759,33 +5754,11 @@ lodash._baseuniq@~4.6.0: lodash._createset "~4.0.0" lodash._root "~3.0.0" -lodash._bindcallback@*: - version "3.0.1" - resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e" - integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4= - -lodash._cacheindexof@*: - version "3.0.2" - resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92" - integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI= - -lodash._createcache@*: - version "3.1.2" - resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093" - integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM= - dependencies: - lodash._getnative "^3.0.0" - lodash._createset@~4.0.0: version "4.0.3" resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26" integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY= -lodash._getnative@*, lodash._getnative@^3.0.0: - version "3.9.1" - resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5" - integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U= - lodash._reinterpolate@~3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d" @@ -5821,11 +5794,6 @@ lodash.padstart@^4.1.0: resolved "https://registry.yarnpkg.com/lodash.padstart/-/lodash.padstart-4.6.1.tgz#d2e3eebff0d9d39ad50f5cbd1b52a7bce6bb611b" integrity sha1-0uPuv/DZ05rVD1y9G1KnvOa7YRs= -lodash.restparam@*: - version "3.6.1" - resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805" - integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU= - lodash.set@^4.3.2: version "4.3.2" resolved "https://registry.yarnpkg.com/lodash.set/-/lodash.set-4.3.2.tgz#d8757b1da807dde24816b0d6a84bea1a76230b23" @@ -7834,7 +7802,7 @@ readable-stream@~2.1.5: string_decoder "~0.10.x" util-deprecate "~1.0.1" -readdir-scoped-modules@*, readdir-scoped-modules@^1.0.0: +readdir-scoped-modules@^1.0.0: version "1.0.2" resolved "https://registry.yarnpkg.com/readdir-scoped-modules/-/readdir-scoped-modules-1.0.2.tgz#9fafa37d286be5d92cbaebdee030dc9b5f406747" integrity sha1-n6+jfShr5dksuuve4DDcm19AZ0c= @@ -9377,7 +9345,7 @@ uuid@~3.1.0: resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.1.0.tgz#3dd3d3e790abc24d7b0d3a034ffababe28ebbc04" integrity sha512-DIWtzUkw04M4k3bf1IcpS2tngXEL26YUD2M0tMDUpnUrz2hgzUBlD55a4FjdLGPvfHxS6uluGWvaVEqgBcVa+g== -validate-npm-package-license@*, validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.3, validate-npm-package-license@~3.0.1: +validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.3, validate-npm-package-license@~3.0.1: version "3.0.4" resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz#fc91f6b9c7ba15c857f4cb2c5defeec39d4f410a" integrity sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==