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

[CI Skip] 0.32.8

Browse Source
This commit is contained in:
Travis CI
2018-10-24 14:06:04 +00:00
parent 0cb6e6c746
commit 0bae9bbb23
157 changed files with 422 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1 -1
View File
@@ -359,7 +359,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"neutral"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"neutral"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/db/classes/_disk_.diskdb.md
+13 -12
View File
@@ -7,6 +7,7 @@
*__description__*: Create an instance of a Disk database using LruDb (for caching with FileFlatDb) and extending TransactionDb. Note that LruDB uses the [Least Recently Used (LRU) cache algorithm](https://www.npmjs.com/package/lru_map)
*__example__*:
```javascript
import stringToU8a from '@polkadot/util/string/toU8a';
import DiskDb from '@polkadot/db/Disk';
@@ -73,7 +74,7 @@ diskDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/Disk.ts#L66)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/Disk.ts#L66)*
**Parameters:**
@@ -97,7 +98,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -110,7 +111,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -129,7 +130,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -142,7 +143,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -155,7 +156,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -174,7 +175,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -193,7 +194,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -206,7 +207,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -226,7 +227,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -246,7 +247,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -259,7 +260,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_engines_filetreedb_.filetreedb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new FileTreeDb**(location: *`string`*): [FileTreeDb](_engines_filetreedb_.filetreedb.md)
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L21)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
**● _location**: *`string`*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L21)*
___
@@ -48,7 +48,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L46)*
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L46)*
**Returns:** `void`
@@ -59,7 +59,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L76)*
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L76)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L50)*
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L50)*
**Returns:** `void`
@@ -87,7 +87,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L54)*
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L54)*
**Returns:** `void`
@@ -98,7 +98,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L86)*
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L86)*
**Parameters:**
@@ -115,7 +115,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L68)*
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L68)*
**Parameters:**
@@ -132,7 +132,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L42)*
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L42)*
**Returns:** `void`
@@ -143,7 +143,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L100)*
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L100)*
**Parameters:**
@@ -161,7 +161,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L58)*
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L58)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/FileTreeDb.ts#L62)*
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/FileTreeDb.ts#L62)*
**Returns:** `number`
docs/db/classes/_engines_lrudb_.lrudb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new LruDb**(backing: *`BaseDb`*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md)
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L20)*
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L20)*
**Parameters:**
@@ -37,7 +37,7 @@ ___
▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` &#124; `undefined`
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L87)*
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L87)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L27)*
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L27)*
**Returns:** `void`
@@ -65,7 +65,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L64)*
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L64)*
**Parameters:**
@@ -82,7 +82,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L41)*
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L41)*
**Returns:** `void`
@@ -93,7 +93,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L45)*
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L45)*
**Returns:** `void`
@@ -104,7 +104,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L71)*
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L71)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L56)*
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L56)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L34)*
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L34)*
**Returns:** `void`
@@ -149,7 +149,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L91)*
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L91)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L52)*
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L52)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/LruDb.ts#L60)*
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/LruDb.ts#L60)*
**Returns:** `number`
docs/db/classes/_engines_memorydb_.memorydb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new MemoryDb**(options?: *`BaseDbOptions`*): [MemoryDb](_engines_memorydb_.memorydb.md)
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L16)*
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L16)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L22)*
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L22)*
**Returns:** `void`
@@ -47,7 +47,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L56)*
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L56)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L30)*
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L30)*
**Returns:** `void`
@@ -75,7 +75,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L34)*
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L34)*
**Returns:** `void`
@@ -86,7 +86,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L62)*
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L62)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L42)*
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L42)*
**Parameters:**
@@ -120,7 +120,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L26)*
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L26)*
**Returns:** `void`
@@ -131,7 +131,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L68)*
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L68)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L38)*
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L38)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/MemoryDb.ts#L50)*
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/MemoryDb.ts#L50)*
**Returns:** `number`
docs/db/classes/_engines_transactiondb_.transactiondb.md
+12 -12
View File
@@ -20,7 +20,7 @@
⊕ **new TransactionDb**(backing: *`BaseDb`*): [TransactionDb](_engines_transactiondb_.transactiondb.md)
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L21)*
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L21)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -51,7 +51,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -68,7 +68,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -79,7 +79,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -135,7 +135,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -153,7 +153,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -182,7 +182,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_fileflatdb_compact_.compact.md
+2 -2
View File
@@ -12,7 +12,7 @@
⊕ **new Compact**(file: *`string`*): [Compact](_fileflatdb_compact_.compact.md)
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/Compact.ts#L17)*
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/Compact.ts#L17)*
**Parameters:**
@@ -32,7 +32,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/Compact.ts#L24)*
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/Compact.ts#L24)*
**Parameters:**
docs/db/classes/_fileflatdb_index_.fileflatdb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new FileFlatDb**(base: *`string`*, file?: *`string`*, options?: *`BaseDbOptions`*): [FileFlatDb](_fileflatdb_index_.fileflatdb.md)
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L32)*
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L32)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
▸ **close**(): `void`
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L58)*
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L58)*
**Returns:** `void`
@@ -49,7 +49,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L105)*
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L105)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
▸ **drop**(): `void`
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L68)*
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L68)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
▸ **empty**(): `void`
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L74)*
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L74)*
**Returns:** `void`
@@ -88,7 +88,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L109)*
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L109)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L97)*
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L97)*
**Parameters:**
@@ -122,7 +122,7 @@ ___
▸ **open**(): `void`
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L48)*
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L48)*
**Returns:** `void`
@@ -133,7 +133,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L127)*
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L127)*
**Parameters:**
@@ -151,7 +151,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L85)*
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L85)*
**Parameters:**
@@ -169,7 +169,7 @@ ___
▸ **size**(): `number`
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/index.ts#L81)*
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/index.ts#L81)*
**Returns:** `number`
docs/db/classes/_memory_.memory.md
+13 -12
View File
@@ -10,6 +10,7 @@
* Disable compression when storing "state" Transactions Trie using @polkadot/trie-db or @polkadot/db/src/engines/TransactionDb.ts (potentially LevelDb or RocksDb implementation of a Merkle Patricia Trie) data structure serialised with Recursive Length Prefix (RLP) encoding
*__example__*:
```javascript
import stringToU8a from '@polkadot/util/string/toU8a';
import MemoryDb from '@polkadot/db/Memory';
@@ -71,7 +72,7 @@ memoryDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/Memory.ts#L66)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/Memory.ts#L66)*
**Parameters:**
@@ -93,7 +94,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -106,7 +107,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -125,7 +126,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -138,7 +139,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -151,7 +152,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -170,7 +171,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -189,7 +190,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -202,7 +203,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -222,7 +223,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -242,7 +243,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -255,7 +256,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/enums/_fileflatdb_types_.slot.md
+3 -3
View File
@@ -18,7 +18,7 @@
**BRANCH**: = 1
*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/types.ts#L7)*
*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/types.ts#L7)*
___
<a id="empty"></a>
@@ -27,7 +27,7 @@ ___
**EMPTY**: = 0
*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/types.ts#L6)*
*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/types.ts#L6)*
___
<a id="leaf"></a>
@@ -36,7 +36,7 @@ ___
**LEAF**: = 2
*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/types.ts#L8)*
*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/types.ts#L8)*
___
docs/db/modules/_fileflatdb_types_.md
+3 -3
View File
@@ -22,7 +22,7 @@
**Ƭ Key**: *`object`*
*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/FileFlatDb/types.ts#L16)*
*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/0cb6e6c/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/5ce8f91/packages/db/src/FileFlatDb/types.ts#L11)*
*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/0cb6e6c/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/5ce8f91/packages/db/src/FileFlatDb/types.ts#L22)*
*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/FileFlatDb/types.ts#L22)*
#### Type declaration
docs/examples/keyring/01_create_account/index.html
+1 -1
View File
@@ -393,7 +393,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Create Account","level":"2.1.1","depth":2,"next":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"previous":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/01_create_account/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Create Account","level":"2.1.1","depth":2,"next":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"previous":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/01_create_account/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/keyring/02_load_accounts/index.html
+1 -1
View File
@@ -405,7 +405,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Load Accounts","level":"2.1.2","depth":2,"next":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"previous":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/02_load_accounts/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Load Accounts","level":"2.1.2","depth":2,"next":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"previous":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/02_load_accounts/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/keyring/index.html
+1 -1
View File
@@ -378,7 +378,7 @@ yarn&#xA0;start
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Keyring","level":"2.1","depth":1,"next":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"previous":{"title":"util-crypto","level":"1.6","depth":1,"path":"util-crypto/README.md","ref":"util-crypto/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Keyring","level":"2.1","depth":1,"next":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"previous":{"title":"util-crypto","level":"1.6","depth":1,"path":"util-crypto/README.md","ref":"util-crypto/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/keyring/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html
+1 -1
View File
@@ -398,7 +398,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"next":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"previous":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"next":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"previous":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/02_sign_verify_message_nacl/index.html
+1 -1
View File
@@ -406,7 +406,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"next":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]},"previous":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"next":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]},"previous":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html
+1 -1
View File
@@ -394,7 +394,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"previous":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"previous":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/index.html
+1 -1
View File
@@ -378,7 +378,7 @@ yarn&#xA0;start
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Util-Crypto","level":"2.2","depth":1,"next":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"previous":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Util-Crypto","level":"2.2","depth":1,"next":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"previous":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"examples/util-crypto/README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+1 -1
View File
@@ -415,7 +415,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"keyring","level":"1.2","depth":1,"path":"keyring/README.md","ref":"keyring/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-24T12:34:09.716Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"keyring","level":"1.2","depth":1,"path":"keyring/README.md","ref":"keyring/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-24T14:02:51.968Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/keyring/classes/_index_.keyring.md
+14 -11
View File
@@ -29,7 +29,7 @@ Overview
⊕ **new Keyring**(): [Keyring](_index_.keyring.md)
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L33)*
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L33)*
**Returns:** [Keyring](_index_.keyring.md)
@@ -43,7 +43,7 @@ ___
▸ **addFromAddress**(address: * `string` &#124; `Uint8Array`*, meta?: *`KeyringPair$Meta`*, defaultEncoded?: *`Uint8Array`*): `KeyringPair`
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L57)*
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L57)*
*__name__*: addFromAddress
@@ -70,7 +70,7 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): `KeyringPair`
*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L72)*
*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L72)*
*__name__*: addFromJson
@@ -97,7 +97,7 @@ ___
▸ **addFromMnemonic**(mnemonic: *`string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [index.ts:85](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L85)*
*Defined in [index.ts:85](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L85)*
*__name__*: addFromMnemonic
@@ -123,7 +123,7 @@ ___
▸ **addFromSeed**(seed: *`Uint8Array`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L114)*
*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L114)*
*__name__*: addFromSeed
@@ -134,6 +134,7 @@ ___
*__description__*: Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. Allows user to provide the account seed as an argument, and then generates a keyring pair from it that it passes to `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
*__example__*:
```javascript
import Keyring from '@polkadot/keyring';
import stringToU8a from '@polkadot/util/string/toU8a';
@@ -165,7 +166,7 @@ ___
▸ **addPair**(pair: *`KeyringPair`*): `KeyringPair`
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L44)*
*__name__*: addPair
@@ -188,7 +189,7 @@ ___
▸ **getPair**(address: * `string` &#124; `Uint8Array`*): `KeyringPair`
*Defined in [index.ts:150](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L150)*
*Defined in [index.ts:150](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L150)*
*__name__*: getPair
@@ -199,6 +200,7 @@ ___
*__description__*: Returns a keyring pair value from the keyring pair dictionary by performing a key lookup using the provided account address or public key (after decoding it).
*__example__*:
```javascript
import Keyring from '@polkadot/keyring';
import stringToU8a from '@polkadot/util/string/toU8a';
@@ -237,7 +239,7 @@ ___
▸ **getPairs**(): `Array`<`KeyringPair`>
*Defined in [index.ts:182](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L182)*
*Defined in [index.ts:182](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L182)*
*__name__*: getPairs
@@ -248,6 +250,7 @@ ___
*__description__*: Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.
*__example__*:
```javascript
import testKeyring from '@polkadot/keyring/testing';
@@ -277,7 +280,7 @@ ___
▸ **getPublicKeys**(): `Array`<`Uint8Array`>
*Defined in [index.ts:192](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L192)*
*Defined in [index.ts:192](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L192)*
*__name__*: getPublicKeys
@@ -296,7 +299,7 @@ ___
▸ **removePair**(address: * `string` &#124; `Uint8Array`*): `void`
*Defined in [index.ts:207](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L207)*
*Defined in [index.ts:207](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L207)*
*__name__*: removePair
@@ -321,7 +324,7 @@ ___
▸ **toJson**(address: * `string` &#124; `Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): `KeyringPair$Json`
*Defined in [index.ts:222](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/index.ts#L222)*
*Defined in [index.ts:222](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/index.ts#L222)*
*__name__*: toJson
docs/keyring/classes/_pairs_.pairs.md
+5 -5
View File
@@ -16,7 +16,7 @@
⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md)
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pairs.ts#L17)*
**Returns:** [Pairs](_pairs_.pairs.md)
@@ -30,7 +30,7 @@ ___
▸ **add**(pair: *`KeyringPair`*): `KeyringPair`
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pairs.ts#L23)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **all**(): `Array`<`KeyringPair`>
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<`KeyringPair`>
@@ -58,7 +58,7 @@ ___
▸ **get**(address: * `string` &#124; `Uint8Array`*): `KeyringPair`
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
▸ **remove**(address: * `string` &#124; `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pairs.ts#L49)*
**Parameters:**
docs/keyring/index.html
+1 -1
View File
@@ -397,7 +397,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"keyring/README.md","mtime":"2018-10-24T12:36:38.333Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"keyring/README.md","mtime":"2018-10-24T14:04:56.679Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/keyring/modules/_address_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(encoded: * `string` &#124; `Uint8Array`*, prefix?: *`Prefix`*): `Uint8Array`
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/address/decode.ts#L15)*
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/address/decode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(_key: * `Uint8Array` &#124; `string`*, prefix?: *`Prefix`*): `string`
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/address/encode.ts#L15)*
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/address/encode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_setprefix_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setPrefix**(prefix: *`Prefix`*): `void`
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/address/setPrefix.ts#L9)*
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/address/setPrefix.ts#L9)*
**Parameters:**
docs/keyring/modules/_pair_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(passphrase?: * `undefined` &#124; `string`*, _encrypted?: *`Uint8Array`*): `object`
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/decode.ts#L15)*
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/decode.ts#L15)*
**Parameters:**
docs/keyring/modules/_pair_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(secretKey: *`Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): `Uint8Array`
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/encode.ts#L10)*
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/encode.ts#L10)*
**Parameters:**
docs/keyring/modules/_pair_getmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getMeta**(state: *`PairState`*): `KeyringPair$Meta`
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/getMeta.ts#L8)*
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/getMeta.ts#L8)*
**Parameters:**
docs/keyring/modules/_pair_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **pair**(__namedParameters: *`object`*, meta?: *`KeyringPair$Meta`*, defaultEncoded?: *`Uint8Array`*): `KeyringPair`
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/index.ts#L50)*
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/index.ts#L50)*
*__name__*: pair
docs/keyring/modules/_pair_nobody_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **everybody**(): `KeyringPair`
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/nobody.ts#L25)*
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/nobody.ts#L25)*
**Returns:** `KeyringPair`
docs/keyring/modules/_pair_setmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setMeta**(state: *`PairState`*, meta: *`KeyringPair$Meta`*): `void`
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/setMeta.ts#L8)*
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/setMeta.ts#L8)*
**Parameters:**
docs/keyring/modules/_pair_tojson_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toJson**(__namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): `KeyringPair$Json`
*Defined in [pair/toJson.ts:10](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/pair/toJson.ts#L10)*
*Defined in [pair/toJson.ts:10](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/pair/toJson.ts#L10)*
**Parameters:**
docs/keyring/modules/_testing_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyring**(): `KeyringInstance`
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/testing.ts#L57)*
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/testing.ts#L57)*
*__name__*: testKeyring
@@ -19,6 +19,7 @@
*__description__*: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds.
*__example__*:
```javascript
import testKeyring from '@polkadot/keyring/testing';
docs/keyring/modules/_testingpairs_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyringPairs**(): `TestKeyringMap`
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/5ce8f91/packages/keyring/src/testingPairs.ts#L14)*
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/keyring/src/testingPairs.ts#L14)*
**Returns:** `TestKeyringMap`
docs/trie-db/classes/_index_.trie.md
+17 -17
View File
@@ -27,7 +27,7 @@ Overview
⊕ **new Trie**(db?: *`TxDb`*, rootHash?: *`Uint8Array`*): [Trie](_index_.trie.md)
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L33)*
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L33)*
**Parameters:**
@@ -50,7 +50,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[db](../interfaces/_types_.triedb.md#db)*
*Defined in [index.ts:31](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L31)*
*Defined in [index.ts:31](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L31)*
___
@@ -64,7 +64,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[close](../interfaces/_types_.triedb.md#close)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L81)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L81)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[del](../interfaces/_types_.triedb.md#del)*
*Defined in [index.ts:105](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L105)*
*Defined in [index.ts:105](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L105)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[drop](../interfaces/_types_.triedb.md#drop)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L89)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L89)*
**Returns:** `void`
@@ -109,7 +109,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[empty](../interfaces/_types_.triedb.md#empty)*
*Defined in [index.ts:85](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L85)*
*Defined in [index.ts:85](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L85)*
**Returns:** `void`
@@ -122,7 +122,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[get](../interfaces/_types_.triedb.md#get)*
*Defined in [index.ts:116](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L116)*
*Defined in [index.ts:116](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L116)*
**Parameters:**
@@ -139,7 +139,7 @@ ___
▸ **getNode**(hash?: *`Uint8Array`*): [Node](../modules/_types_.md#node)
*Defined in [index.ts:147](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L147)*
*Defined in [index.ts:147](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L147)*
**Parameters:**
@@ -158,7 +158,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[getRoot](../interfaces/_types_.triedb.md#getroot)*
*Defined in [index.ts:137](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L137)*
*Defined in [index.ts:137](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L137)*
**Returns:** `Uint8Array`
@@ -171,7 +171,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[maintain](../interfaces/_types_.triedb.md#maintain)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L93)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L93)*
**Parameters:**
@@ -190,7 +190,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[open](../interfaces/_types_.triedb.md#open)*
*Defined in [index.ts:77](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L77)*
*Defined in [index.ts:77](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L77)*
**Returns:** `void`
@@ -203,7 +203,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[put](../interfaces/_types_.triedb.md#put)*
*Defined in [index.ts:125](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L125)*
*Defined in [index.ts:125](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L125)*
**Parameters:**
@@ -223,7 +223,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[rename](../interfaces/_types_.triedb.md#rename)*
*Defined in [index.ts:97](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L97)*
*Defined in [index.ts:97](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L97)*
**Parameters:**
@@ -243,7 +243,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[setRoot](../interfaces/_types_.triedb.md#setroot)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L151)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L151)*
**Parameters:**
@@ -262,7 +262,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[size](../interfaces/_types_.triedb.md#size)*
*Defined in [index.ts:101](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L101)*
*Defined in [index.ts:101](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L101)*
**Returns:** `number`
@@ -275,7 +275,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[snapshot](../interfaces/_types_.triedb.md#snapshot)*
*Defined in [index.ts:156](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L156)*
*Defined in [index.ts:156](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L156)*
**Parameters:**
@@ -293,7 +293,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/index.ts#L57)*
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/index.ts#L57)*
**Parameters:**
docs/trie-db/enums/_types_.nodetype.md
+4 -4
View File
@@ -19,7 +19,7 @@
**BRANCH**: = 3
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L11)*
___
<a id="empty"></a>
@@ -28,7 +28,7 @@ ___
**EMPTY**: = 0
*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L8)*
___
<a id="extension"></a>
@@ -37,7 +37,7 @@ ___
**EXTENSION**: = 2
*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L10)*
___
<a id="leaf"></a>
@@ -46,7 +46,7 @@ ___
**LEAF**: = 1
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L9)*
___
docs/trie-db/index.html
+1 -1
View File
@@ -401,7 +401,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"trie-db","level":"1.3","depth":1,"next":{"title":"trie-hash","level":"1.4","depth":1,"path":"trie-hash/README.md","ref":"trie-hash/README.md","articles":[]},"previous":{"title":"keyring","level":"1.2","depth":1,"path":"keyring/README.md","ref":"keyring/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"trie-db/README.md","mtime":"2018-10-24T12:36:45.957Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"trie-db","level":"1.3","depth":1,"next":{"title":"trie-hash","level":"1.4","depth":1,"path":"trie-hash/README.md","ref":"trie-hash/README.md","articles":[]},"previous":{"title":"keyring","level":"1.2","depth":1,"path":"keyring/README.md","ref":"keyring/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"trie-db/README.md","mtime":"2018-10-24T14:05:03.859Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/trie-db/interfaces/_types_.triedb.md
+15 -15
View File
@@ -18,7 +18,7 @@
**● db**: *`TxDb`*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/0cb6e6c/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.d.ts:18](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L18)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:18](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L18)*
**Returns:** `void`
@@ -45,7 +45,7 @@ ___
*Inherited from BaseDb.del*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:26](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:26](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L26)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
*Inherited from BaseDb.drop*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L20)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L20)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
*Inherited from BaseDb.empty*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L21)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L21)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
*Inherited from BaseDb.get*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L27)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **getRoot**(): `Uint8Array`
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/0cb6e6c/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.d.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L22)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L22)*
**Parameters:**
@@ -139,7 +139,7 @@ ___
*Inherited from BaseDb.open*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:19](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:19](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L19)*
**Returns:** `void`
@@ -152,7 +152,7 @@ ___
*Inherited from BaseDb.put*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:28](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L28)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:28](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L28)*
**Parameters:**
@@ -172,7 +172,7 @@ ___
*Inherited from BaseDb.rename*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:23](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L23)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:23](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L23)*
**Parameters:**
@@ -190,7 +190,7 @@ ___
▸ **setRoot**(rootHash: *`Uint8Array`*): `void`
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/0cb6e6c/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.d.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L24)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.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/5ce8f91/packages/trie-db/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/0cb6e6c/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.d.ts:32](https://github.com/polkadot-js/common/blob/5ce8f91/packages/db/src/types.d.ts#L32)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:32](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/db/src/types.d.ts#L32)*
**Parameters:**
docs/trie-db/modules/_types_.md
+8 -8
View File
@@ -32,7 +32,7 @@
**Ƭ EncodedPath**: * `Uint8Array` &#124; `null`
*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L28)*
___
<a id="node"></a>
@@ -42,7 +42,7 @@ ___
**Ƭ Node**: * [NodeEmpty](_types_.md#nodeempty) &#124; [NodeNotEmpty](_types_.md#nodenotempty)
*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L34)*
___
<a id="nodebranch"></a>
@@ -51,7 +51,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/5ce8f91/packages/trie-db/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L20)*
___
<a id="nodeempty"></a>
@@ -60,7 +60,7 @@ ___
**Ƭ NodeEmpty**: *`null`*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L14)*
___
<a id="nodeencoded"></a>
@@ -69,7 +69,7 @@ ___
**Ƭ NodeEncoded**: *`Uint8Array`*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L16)*
___
<a id="nodeencodedorempty"></a>
@@ -79,7 +79,7 @@ ___
**Ƭ NodeEncodedOrEmpty**: * [NodeEncoded](_types_.md#nodeencoded) &#124; [NodeEmpty](_types_.md#nodeempty)
*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L18)*
___
<a id="nodekv"></a>
@@ -88,7 +88,7 @@ ___
**Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L30)*
___
<a id="nodenotempty"></a>
@@ -98,7 +98,7 @@ ___
**Ƭ NodeNotEmpty**: * [NodeKv](_types_.md#nodekv) &#124; [NodeBranch](_types_.md#nodebranch)
*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/types.ts#L32)*
___
docs/trie-db/modules/_util_is_.md
+5 -5
View File
@@ -8,7 +8,7 @@
▸ **isBranchNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:57](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/is.ts#L57)*
*Defined in [util/is.ts:57](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/is.ts#L57)*
*__name__*: isBranchNode
@@ -33,7 +33,7 @@ ___
▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:17](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/is.ts#L17)*
*Defined in [util/is.ts:17](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/is.ts#L17)*
*__name__*: isEmptyNode
@@ -58,7 +58,7 @@ ___
▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:37](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/is.ts#L37)*
*Defined in [util/is.ts:37](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/is.ts#L37)*
*__name__*: isExtensionNode
@@ -83,7 +83,7 @@ ___
▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/is.ts#L27)*
*Defined in [util/is.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/is.ts#L27)*
*__name__*: isKvNode
@@ -108,7 +108,7 @@ ___
▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:47](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/is.ts#L47)*
*Defined in [util/is.ts:47](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/is.ts#L47)*
*__name__*: isLeafNode
docs/trie-db/modules/_util_key_.md
+7 -7
View File
@@ -8,7 +8,7 @@
▸ **computeExtensionKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath)
*Defined in [util/key.ts:50](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L50)*
*Defined in [util/key.ts:50](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L50)*
**Parameters:**
@@ -25,7 +25,7 @@ ___
▸ **computeLeafKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath)
*Defined in [util/key.ts:54](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L54)*
*Defined in [util/key.ts:54](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L54)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
▸ **consumeCommonPrefix**(left: *`Uint8Array`*, right: *`Uint8Array`*): [`Uint8Array`, `Uint8Array`, `Uint8Array`]
*Defined in [util/key.ts:70](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L70)*
*Defined in [util/key.ts:70](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L70)*
**Parameters:**
@@ -60,7 +60,7 @@ ___
▸ **extractKey**(node: *[Node](_types_.md#node)*): `Uint8Array`
*Defined in [util/key.ts:12](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L12)*
*Defined in [util/key.ts:12](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L12)*
**Parameters:**
@@ -77,7 +77,7 @@ ___
▸ **getCommonPrefixLength**(left: *`Uint8Array`*, right: *`Uint8Array`*): `number`
*Defined in [util/key.ts:60](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L60)*
*Defined in [util/key.ts:60](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L60)*
**Parameters:**
@@ -95,7 +95,7 @@ ___
▸ **keyEquals**(key: * `Uint8Array` &#124; `null`*, test: * `Uint8Array` &#124; `null`*): `boolean`
*Defined in [util/key.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L24)*
*Defined in [util/key.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L24)*
**Parameters:**
@@ -113,7 +113,7 @@ ___
▸ **keyStartsWith**(key: * `Uint8Array` &#124; `null`*, partial: * `Uint8Array` &#124; `null`*): `boolean`
*Defined in [util/key.ts:34](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/key.ts#L34)*
*Defined in [util/key.ts:34](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/key.ts#L34)*
**Parameters:**
docs/trie-db/modules/_util_nibbles_.md
+5 -5
View File
@@ -8,7 +8,7 @@
▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [util/nibbles.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/nibbles.ts#L22)*
*Defined in [util/nibbles.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/nibbles.ts#L22)*
**Parameters:**
@@ -25,7 +25,7 @@ ___
▸ **decodeNibbles**(value: *[NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)*): `Uint8Array`
*Defined in [util/nibbles.ts:43](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/nibbles.ts#L43)*
*Defined in [util/nibbles.ts:43](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/nibbles.ts#L43)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
▸ **encodeNibbles**(nibbles: *`Uint8Array`*): [NodeEncoded](_types_.md#nodeencoded)
*Defined in [util/nibbles.ts:56](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/nibbles.ts#L56)*
*Defined in [util/nibbles.ts:56](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/nibbles.ts#L56)*
**Parameters:**
@@ -59,7 +59,7 @@ ___
▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean`
*Defined in [util/nibbles.ts:18](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/nibbles.ts#L18)*
*Defined in [util/nibbles.ts:18](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/nibbles.ts#L18)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [util/nibbles.ts:35](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/nibbles.ts#L35)*
*Defined in [util/nibbles.ts:35](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/nibbles.ts#L35)*
**Parameters:**
docs/trie-db/modules/_util_node_.md
+3 -3
View File
@@ -8,7 +8,7 @@
▸ **decodeNode**(encoded: * `Uint8Array` &#124; [Node](_types_.md#node)*): [Node](_types_.md#node)
*Defined in [util/node.ts:31](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/node.ts#L31)*
*Defined in [util/node.ts:31](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/node.ts#L31)*
**Parameters:**
@@ -25,7 +25,7 @@ ___
▸ **encodeNode**(node: *[Node](_types_.md#node)*): `Uint8Array`
*Defined in [util/node.ts:48](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/node.ts#L48)*
*Defined in [util/node.ts:48](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/node.ts#L48)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
▸ **getNodeType**(node: *[Node](_types_.md#node)*): [NodeType](../enums/_types_.nodetype.md)
*Defined in [util/node.ts:14](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-db/src/util/node.ts#L14)*
*Defined in [util/node.ts:14](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-db/src/util/node.ts#L14)*
**Parameters:**
docs/trie-hash/index.html
+1 -1
View File
@@ -412,7 +412,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"trie-hash","level":"1.4","depth":1,"next":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"previous":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"trie-hash/README.md","mtime":"2018-10-24T12:36:53.093Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"trie-hash","level":"1.4","depth":1,"next":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"previous":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"trie-hash/README.md","mtime":"2018-10-24T14:05:10.459Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/trie-hash/modules/_encode_aux_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeAux**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Uint8Array` &#124; `any`[]
*Defined in [encode/aux.ts:12](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/aux.ts#L12)*
*Defined in [encode/aux.ts:12](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/aux.ts#L12)*
**Parameters:**
docs/trie-hash/modules/_encode_hexprefix_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeHexPrefix**(nibbles: * `Uint8Array` &#124; `Array`<`number`>*, isLeaf: *`boolean`*): `Uint8Array`
*Defined in [encode/hexPrefix.ts:5](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/hexPrefix.ts#L5)*
*Defined in [encode/hexPrefix.ts:5](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/hexPrefix.ts#L5)*
**Parameters:**
docs/trie-hash/modules/_encode_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/index.ts:36](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/index.ts#L36)*
*Defined in [encode/index.ts:36](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/index.ts#L36)*
*__name__*: encode
docs/trie-hash/modules/_encode_pairs_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodePairs**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/pairs.ts:23](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/pairs.ts#L23)*
*Defined in [encode/pairs.ts:23](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/pairs.ts#L23)*
**Parameters:**
docs/trie-hash/modules/_encode_shared_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeShared**(pairs: *`Trie$Pairs`*, preLength: *`number`*, sharedLength: *`number`*): `Array`<`any`>
*Defined in [encode/shared.ts:10](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/shared.ts#L10)*
*Defined in [encode/shared.ts:10](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/shared.ts#L10)*
**Parameters:**
docs/trie-hash/modules/_encode_single_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeSingle**(pair: *`Trie$Pair`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/single.ts:9](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/encode/single.ts#L9)*
*Defined in [encode/single.ts:9](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/encode/single.ts#L9)*
**Parameters:**
docs/trie-hash/modules/_root_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **trieRoot**(pairs: *`Trie$Pairs`*): `Uint8Array`
*Defined in [root.ts:30](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/root.ts#L30)*
*Defined in [root.ts:30](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/root.ts#L30)*
*__name__*: trieRoot
@@ -19,6 +19,7 @@
*__description__*: From an `Array<{k: Uint8Array, v: Uint8Array}>` input, calculate the triehash and return the result as a `Uint8Array`.
*__example__*:
```javascript
import { stringToU8a } from '@polkadot/util';
import { trieRoot } from '@polkadot/trie-hash';
docs/trie-hash/modules/_rootordered_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **trieRootOrdered**(values: *`Array`<`Uint8Array`>*): `Uint8Array`
*Defined in [rootOrdered.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/rootOrdered.ts#L29)*
*Defined in [rootOrdered.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/rootOrdered.ts#L29)*
*__name__*: trieRootOrdered
@@ -19,6 +19,7 @@
*__description__*: From an `Array<Uint8Array>` input, calculate the ordered triehash and return the result as a `Uint8Array`.
*__example__*:
```javascript
import { stringToU8a } from '@polkadot/util';
import { trieRootOrdered } from '@polkadot/trie-hash';
docs/trie-hash/modules/_util_asnibbles_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **asNibbles**(bytes: * `Uint8Array` &#124; `Array`<`number`> &#124; `null`*): `Uint8Array`
*Defined in [util/asNibbles.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/asNibbles.ts#L20)*
*Defined in [util/asNibbles.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/asNibbles.ts#L20)*
*__name__*: asNibbles
@@ -19,6 +19,7 @@
*__description__*: From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input.
*__example__*:
```javascript
import { asNibbles } from '@polkadot/trie-hash/util';
docs/trie-hash/modules/_util_fromnibbles_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **fromNibbles**(nibbles: * `Uint8Array` &#124; `Array`<`number`>*): `Uint8Array`
*Defined in [util/fromNibbles.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/fromNibbles.ts#L20)*
*Defined in [util/fromNibbles.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/fromNibbles.ts#L20)*
*__name__*: fromNibbles
@@ -19,6 +19,7 @@
*__description__*: From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input.
*__example__*:
```javascript
import { fromNibbles } from '@polkadot/trie-hash/util';
docs/trie-hash/modules/_util_genroot_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **genRoot**(pairs: *`Trie$Pairs`*): `Uint8Array`
*Defined in [util/genRoot.ts:17](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/genRoot.ts#L17)*
*Defined in [util/genRoot.ts:17](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/genRoot.ts#L17)*
*__name__*: genRoot
docs/trie-hash/modules/_util_pairsuniq_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **pairsUniq**(pairs: *`Trie$Pairs`*): `Trie$Pairs`
*Defined in [util/pairsUniq.ts:18](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/pairsUniq.ts#L18)*
*Defined in [util/pairsUniq.ts:18](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/pairsUniq.ts#L18)*
*__name__*: pairsUniq
docs/trie-hash/modules/_util_sharedlength_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getSharedLength**(a: *`Uint8Array`*, b: *`Uint8Array`*): `number`
*Defined in [util/sharedLength.ts:13](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/sharedLength.ts#L13)*
*Defined in [util/sharedLength.ts:13](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/sharedLength.ts#L13)*
*__name__*: getSharedLength
docs/trie-hash/modules/_util_sharedprefixlength_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **sharedPrefixLength**(pairs: *`Trie$Pairs`*): `number`
*Defined in [util/sharedPrefixLength.ts:13](https://github.com/polkadot-js/common/blob/5ce8f91/packages/trie-hash/src/util/sharedPrefixLength.ts#L13)*
*Defined in [util/sharedPrefixLength.ts:13](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/trie-hash/src/util/sharedPrefixLength.ts#L13)*
*__name__*: sharedPrefixLength
docs/util-crypto/README.md
+1 -1
View File
@@ -68,7 +68,7 @@ Below is a list of currently exposed methods published at the [Polkadot-JS Commo
* Uses the [Blake2b](https://blake2.net/) hash function of [blakejs](https://www.npmjs.com/package/blakejs) library
* Note: All hashes used in Polkadot-JS are 32 bytes (i.e. 256 / 8)
* Note: BLAKE hash functions are in the Nacl library
* Note: Only handles up to 2**53 bytes of input
* Note: Only handles up to 2\*\*53 bytes of input
### Keccak
docs/util-crypto/index.html
+1 -1
View File
@@ -485,7 +485,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"util-crypto","level":"1.6","depth":1,"next":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"previous":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"util-crypto/README.md","mtime":"2018-10-24T12:37:07.793Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T12:37:43.748Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"util-crypto","level":"1.6","depth":1,"next":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"previous":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"util-crypto/README.md","mtime":"2018-10-24T14:05:24.139Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-24T14:05:57.961Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/util-crypto/modules/_blake2_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2AsHex**(data: *`Uint8Array`*, bitLength?: *`number`*): `string`
*Defined in [blake2/asHex.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/blake2/asHex.ts#L22)*
*Defined in [blake2/asHex.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/blake2/asHex.ts#L22)*
*__name__*: blake2AsHex
@@ -19,6 +19,7 @@
*__description__*: From a `Uint8Array` input, create the blake2b and return the result as a hex string with the specified `bitLength`.
*__example__*:
```javascript
import { blake2AsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_blake2_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2AsU8a**(data: *`Uint8Array`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array`
*Defined in [blake2/asU8a.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/blake2/asU8a.ts#L22)*
*Defined in [blake2/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/blake2/asU8a.ts#L22)*
*__name__*: blake2AsU8a
@@ -19,6 +19,7 @@
*__description__*: From a `Uint8Array` input, create the blake2b and return the result as a u8a with the specified `bitLength`.
*__example__*:
```javascript
import { blake2AsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_blake2_blake2b_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2bAsHex**(data: *`Uint8Array`*, bitLength?: *`number`*): `string`
*Defined in [blake2/blake2b/asHex.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/blake2/blake2b/asHex.ts#L24)*
*Defined in [blake2/blake2b/asHex.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/blake2/blake2b/asHex.ts#L24)*
*__name__*: blake2bAsHex
@@ -19,6 +19,7 @@
*__description__*: From a `Uint8Array` input, create the blake2b and return the result as a hex string.
*__example__*:
```javascript
import { blake2bAsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_blake2_blake2b_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2bAsU8a**(data: *`Uint8Array`*, bitLength?: *`number`*, key?: * `Uint8Array` &#124; `null`*): `Uint8Array`
*Defined in [blake2/blake2b/asU8a.ts:23](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L23)*
*Defined in [blake2/blake2b/asU8a.ts:23](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L23)*
*__name__*: blake2bAsU8a
@@ -19,6 +19,7 @@
*__description__*: From a `Uint8Array` input, create the blake2b and return the result as a `Uint8Array`.
*__example__*:
```javascript
import { blake2bAsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_keccak_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **keccakAsHex**(value: * `Buffer` &#124; `Uint8Array` &#124; `string`*): `string`
*Defined in [keccak/asHex.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/keccak/asHex.ts#L24)*
*Defined in [keccak/asHex.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/keccak/asHex.ts#L24)*
*__name__*: keccakAsHex
@@ -19,6 +19,7 @@
*__description__*: From either a `string` or a `Buffer` input, create the keccak and return the result as a `0x` prefixed hex string.
*__example__*:
```javascript
import { keccakAsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_keccak_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **keccakAsU8a**(value: * `Buffer` &#124; `Uint8Array` &#124; `string`*): `Uint8Array`
*Defined in [keccak/asU8a.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/keccak/asU8a.ts#L22)*
*Defined in [keccak/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/keccak/asU8a.ts#L22)*
*__name__*: keccakAsU8a
@@ -19,6 +19,7 @@
*__description__*: From either a `string` or a `Buffer` input, create the keccak and return the result as a `Uint8Array`.
*__example__*:
```javascript
import { keccakAsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_mnemonic_generate_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **mnemonicGenerate**(): `string`
*Defined in [mnemonic/generate.ts:20](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/mnemonic/generate.ts#L20)*
*Defined in [mnemonic/generate.ts:20](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/mnemonic/generate.ts#L20)*
*__name__*: mnemonicGenerate
@@ -17,6 +17,7 @@
*__summary__*: Creates a valid mnemonic string using using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
*__example__*:
```javascript
import { mnemonicGenerate } from '@polkadot/util-crypto';
docs/util-crypto/modules/_mnemonic_tosecret_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toSecret**(mnemonic: *`string`*): `Uint8Array`
*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/mnemonic/toSecret.ts#L8)*
*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/mnemonic/toSecret.ts#L8)*
**Parameters:**
docs/util-crypto/modules/_mnemonic_toseed_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **toSeed**(mnemonic: *`string`*): `Uint8Array`
*Defined in [mnemonic/toSeed.ts:25](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/mnemonic/toSeed.ts#L25)*
*Defined in [mnemonic/toSeed.ts:25](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/mnemonic/toSeed.ts#L25)*
*__name__*: toSeed
@@ -17,6 +17,7 @@
*__summary__*: Creates a valid seed from a mnemonic input
*__example__*:
```javascript
import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
docs/util-crypto/modules/_mnemonic_validate_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean`
*Defined in [mnemonic/validate.ts:21](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/mnemonic/validate.ts#L21)*
*Defined in [mnemonic/validate.ts:21](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/mnemonic/validate.ts#L21)*
*__name__*: mnemonicValidate
@@ -17,6 +17,7 @@
*__summary__*: Validates a mnemonic input using [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
*__example__*:
```javascript
import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_decrypt_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [nacl/decrypt.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/decrypt.ts#L22)*
*Defined in [nacl/decrypt.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/decrypt.ts#L22)*
*__name__*: naclDecrypt
@@ -19,6 +19,7 @@
*__description__*: Returns an decrypted message, using the `secret` and `nonce`.
*__example__*:
```javascript
import { naclDecrypt } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_encrypt_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclEncrypt**(message: *`Uint8Array`*, secret: *`Uint8Array`*, nonce?: *`Uint8Array`*): `Encrypted`
*Defined in [nacl/encrypt.ts:29](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/encrypt.ts#L29)*
*Defined in [nacl/encrypt.ts:29](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/encrypt.ts#L29)*
*__name__*: naclEncrypt
@@ -19,6 +19,7 @@
*__description__*: Returns an encrypted message, using the `secretKey` and `nonce`. If the `nonce` was not supplied, a random value is generated.
*__example__*:
```javascript
import { naclEncrypt } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_keypair_fromrandom_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromRandom**(): `KeypairType`
*Defined in [nacl/keypair/fromRandom.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L24)*
*Defined in [nacl/keypair/fromRandom.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L24)*
*__name__*: naclKeypairFromRandom
@@ -19,6 +19,7 @@
*__description__*: Returns a new generate object containing a `publicKey` & `secretKey`.
*__example__*:
```javascript
import { naclKeypairFromRandom } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_keypair_fromsecret_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromSecret**(secret: *`Uint8Array`*): `KeypairType`
*Defined in [nacl/keypair/fromSecret.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L24)*
*Defined in [nacl/keypair/fromSecret.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L24)*
*__name__*: naclKeypairFromSecret
@@ -19,6 +19,7 @@
*__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied secret.
*__example__*:
```javascript
import { naclKeypairFromSecret } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_keypair_fromseed_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromSeed**(seed: *`Uint8Array`*): `KeypairType`
*Defined in [nacl/keypair/fromSeed.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L24)*
*Defined in [nacl/keypair/fromSeed.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L24)*
*__name__*: naclKeypairFromSeed
@@ -19,6 +19,7 @@
*__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed.
*__example__*:
```javascript
import { naclKeypairFromSeed } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_keypair_fromstring_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromString**(value: *`string`*): `KeypairType`
*Defined in [nacl/keypair/fromString.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/keypair/fromString.ts#L27)*
*Defined in [nacl/keypair/fromString.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/keypair/fromString.ts#L27)*
*__name__*: naclKeypairFromString
@@ -19,6 +19,7 @@
*__description__*: Returns a object containing a `publicKey` & `secretKey` generated from the supplied string. The string is hashed and the value used as the input seed.
*__example__*:
```javascript
import { naclKeypairFromString } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_sign_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclSign**(message: *`Uint8Array`*, secretKey: *`Uint8Array`*): `Uint8Array`
*Defined in [nacl/sign.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/sign.ts#L22)*
*Defined in [nacl/sign.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/sign.ts#L22)*
*__name__*: naclSign
@@ -19,6 +19,7 @@
*__description__*: Returns message signature of `message`, using the `secretKey`.
*__example__*:
```javascript
import { naclSign } from '@polkadot/util-crypto';
docs/util-crypto/modules/_nacl_verify_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **naclVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean`
*Defined in [nacl/verify.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/nacl/verify.ts#L22)*
*Defined in [nacl/verify.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/nacl/verify.ts#L22)*
*__name__*: naclSign
@@ -19,6 +19,7 @@
*__description__*: Verifies the `signature` on `message` with the supplied `plublicKey`. Returns `true` on sucess, `false` otherwise.
*__example__*:
```javascript
import { naclVerify } from '@polkadot/util-crypto';
docs/util-crypto/modules/_random_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **randomAsHex**(length?: *`number`*): `string`
*Defined in [random/asHex.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/random/asHex.ts#L24)*
*Defined in [random/asHex.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/random/asHex.ts#L24)*
*__name__*: randomAsHex
@@ -19,6 +19,7 @@
*__description__*: Returns a hex string with the specified (optional) length filled with random bytes.
*__example__*:
```javascript
import { randomAsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_random_asnumber_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **randomAsNumber**(): `number`
*Defined in [random/asNumber.ts:27](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/random/asNumber.ts#L27)*
*Defined in [random/asNumber.ts:27](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/random/asNumber.ts#L27)*
*__name__*: randomAsNumber
@@ -19,6 +19,7 @@
*__description__*: Returns a random number generated from the secure bytes.
*__example__*:
```javascript
import { randomAsNumber } from '@polkadot/util-crypto';
docs/util-crypto/modules/_random_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **randomAsU8a**(length?: *`number`*): `Uint8Array`
*Defined in [random/asU8a.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/random/asU8a.ts#L22)*
*Defined in [random/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/random/asU8a.ts#L22)*
*__name__*: randomAsU8a
@@ -19,6 +19,7 @@
*__description__*: Returns a `Uint8Array` with the specified (optional) length filled with random bytes.
*__example__*:
```javascript
import { randomAsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_sha512_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **sha512AsU8a**(data: *`Uint8Array`*): `Uint8Array`
*Defined in [sha512/asU8a.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/sha512/asU8a.ts#L22)*
*Defined in [sha512/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/sha512/asU8a.ts#L22)*
*__name__*: sha512AsU8a
@@ -19,6 +19,7 @@
*__description__*: Returns a sha-512 `Uint8Array` from the supplied data.
*__example__*:
```javascript
import { sha512AsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhashAsHex**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, bitLength?: *`number`*): `string`
*Defined in [xxhash/asHex.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/asHex.ts#L24)*
*Defined in [xxhash/asHex.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/asHex.ts#L24)*
*__name__*: xxhashAsHex
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a hex string with the specified `bitLength`.
*__example__*:
```javascript
import { xxhashAsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_asu8a_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhashAsU8a**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, bitLength?: *`number`*): `Uint8Array`
*Defined in [xxhash/asU8a.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/asU8a.ts#L22)*
*Defined in [xxhash/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/asU8a.ts#L22)*
*__name__*: xxhashAsU8a
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash64 and return the result as a `Uint8Array` with the specified `bitLength`.
*__example__*:
```javascript
import { xxhashAsU8a } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhash64AsBn**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, seed: *`number`*): `BN`
*Defined in [xxhash/xxhash64/asBn.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L24)*
*Defined in [xxhash/xxhash64/asBn.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L24)*
*__name__*: xxhash64AsBn
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a BN.
*__example__*:
```javascript
import { xxhash64AsNumber } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhash64AsHex**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, seed: *`number`*): `string`
*Defined in [xxhash/xxhash64/asHex.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L24)*
*Defined in [xxhash/xxhash64/asHex.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L24)*
*__name__*: xxhash64AsHex
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex string.
*__example__*:
```javascript
import { xxhash64AsHex } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhash64AsRaw**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, seed: *`number`*): `string`
*Defined in [xxhash/xxhash64/asRaw.ts:22](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L22)*
*Defined in [xxhash/xxhash64/asRaw.ts:22](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L22)*
*__name__*: xxhash64AsRaw
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a non-prefixed hex string.
*__example__*:
```javascript
import { xxhash64AsRaw } from '@polkadot/util-crypto';
docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **xxhash64AsValue**(data: * `Buffer` &#124; `Uint8Array` &#124; `string`*, seed: *`number`*): `number`
*Defined in [xxhash/xxhash64/asValue.ts:23](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L23)*
*Defined in [xxhash/xxhash64/asValue.ts:23](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L23)*
*__name__*: xxhash64AsValue
@@ -19,6 +19,7 @@
*__description__*: From either a `string`, `Uint8Array` or a `Buffer` input, create the xxhash and return the result as a hex number
*__example__*:
```javascript
import { xxhash64AsValue } from '@polkadot/util-crypto';
docs/util-rlp/modules/_decoder_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/decode.ts#L28)*
*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/decode.ts#L28)*
**Parameters:**
docs/util-rlp/modules/_decoder_index_.md
+3 -2
View File
@@ -8,17 +8,18 @@
▸ **decoder**(input?: *`Uint8Array`*): `Uint8Array` &#124; `Array`<`any`>
*Defined in [decoder/index.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/index.ts#L24)*
*Defined in [decoder/index.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/index.ts#L24)*
*__name__*: decoder
*__signature__*: decoder (input?: Uint8Array): Uint8Array | Array<*>
*__signature__*: decoder (input?: Uint8Array): Uint8Array | Array<\*>
*__summary__*: Decodes the input RLP.
*__description__*: From an input, decode the RLP and return the result as a `Uint8Array` or `Array`.
*__example__*:
```javascript
import { decode } from '@polkadot/util-rlp';
docs/util-rlp/modules/_decoder_listlong_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeListLong**(decode: *`DecodeFunc`*, input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/listLong.ts#L11)*
*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/listLong.ts#L11)*
**Parameters:**
docs/util-rlp/modules/_decoder_listshort_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeListShort**(decode: *`DecodeFunc`*, input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/listShort.ts#L7)*
*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/listShort.ts#L7)*
**Parameters:**
docs/util-rlp/modules/_decoder_number_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeNumber**(decode: *`DecodeFunc`*, input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/number.ts#L11)*
*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/number.ts#L11)*
**Parameters:**
docs/util-rlp/modules/_decoder_safeparseint_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **safeParseInt**(input: *`Uint8Array`*): `number`
*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/safeParseInt.ts#L7)*
*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/safeParseInt.ts#L7)*
**Parameters:**
docs/util-rlp/modules/_decoder_single_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeSingle**(decode: *`DecodeFunc`*, input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/single.ts#L7)*
*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/single.ts#L7)*
**Parameters:**
docs/util-rlp/modules/_decoder_string_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeString**(decode: *`DecodeFunc`*, input: *`Uint8Array`*): `DecodeOutput`
*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/decoder/string.ts#L9)*
*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/decoder/string.ts#L9)*
**Parameters:**
docs/util-rlp/modules/_encoder_array_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeArray**(encoder: *`EncodeFunc`*, input: *`any`*): `Uint8Array`
*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/encoder/array.ts#L11)*
*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/encoder/array.ts#L11)*
**Parameters:**
docs/util-rlp/modules/_encoder_index_.md
+2 -1
View File
@@ -8,7 +8,7 @@
▸ **encoder**(input: *`any`*): `Uint8Array`
*Defined in [encoder/index.ts:24](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/encoder/index.ts#L24)*
*Defined in [encoder/index.ts:24](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/encoder/index.ts#L24)*
*__name__*: encoder
@@ -19,6 +19,7 @@
*__description__*: From an input, calculate the RLP and return the result as a `Uint8Array`.
*__example__*:
```javascript
import { encode } from '@polkadot/util-rlp';
docs/util-rlp/modules/_encoder_length_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeLength**(length: *`number`*, offset: *`number`*): `Uint8Array`
*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/encoder/length.ts#L7)*
*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/encoder/length.ts#L7)*
**Parameters:**
docs/util-rlp/modules/_encoder_tou8a_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toU8a**(value: *`any`*): `Uint8Array`
*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/5ce8f91/packages/util-rlp/src/encoder/toU8a.ts#L39)*
*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/0cb6e6c/packages/util-rlp/src/encoder/toU8a.ts#L39)*
**Parameters:**

Some files were not shown because too many files have changed in this diff Show More