diff --git a/docs/.vuepress/dist/404.html b/docs/.vuepress/dist/404.html index c0aa2c72b..0bb95ee11 100644 --- a/docs/.vuepress/dist/404.html +++ b/docs/.vuepress/dist/404.html @@ -7,11 +7,11 @@ - +

404

There's nothing here.
Take me home.
- + diff --git a/docs/.vuepress/dist/CONTRIBUTING.html b/docs/.vuepress/dist/CONTRIBUTING.html index 1cc033f1c..b8226d2a4 100644 --- a/docs/.vuepress/dist/CONTRIBUTING.html +++ b/docs/.vuepress/dist/CONTRIBUTING.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. +

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

. No --force pushes or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo. . Non-master branches, prefixed with a short name moniker (e.g. <initials>-<feature>) must be used for ongoing work. . All modifications must be made in a pull-request to solicit feedback from other contributors. @@ -28,11 +28,11 @@ When reviewing a pull request, the end-goal is to suggest useful changes to the . Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on). . Uselessness (i.e. it does not strictly add a feature or fix a known issue).

.Reviews may not be used as an effective veto for a PR because: . There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix. -. It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

Last Updated: 2/13/2019, 4:33:49 PM

+. It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

Last Updated: 2/13/2019, 4:38:56 PM

←

- + diff --git a/docs/.vuepress/dist/assets/js/100.3fd2d86f.js b/docs/.vuepress/dist/assets/js/100.eada1ee7.js similarity index 92% rename from docs/.vuepress/dist/assets/js/100.3fd2d86f.js rename to docs/.vuepress/dist/assets/js/100.eada1ee7.js index 69b018063..c2c0157b3 100644 --- a/docs/.vuepress/dist/assets/js/100.3fd2d86f.js +++ b/docs/.vuepress/dist/assets/js/100.eada1ee7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{485:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"sharedprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"sharedprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sharedprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" sharedPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sharedPrefixLength")]),t._v("(first: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", second: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/sharedPrefixLength.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/sharedPrefixLength.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("first")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("second")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{483:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"sharedprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"sharedprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sharedprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" sharedPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sharedPrefixLength")]),t._v("(first: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", second: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/sharedPrefixLength.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/sharedPrefixLength.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("first")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("second")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/101.5b63f1c7.js b/docs/.vuepress/dist/assets/js/101.c0266c71.js similarity index 96% rename from docs/.vuepress/dist/assets/js/101.5b63f1c7.js rename to docs/.vuepress/dist/assets/js/101.c0266c71.js index 99a802e03..ab64f471b 100644 --- a/docs/.vuepress/dist/assets/js/101.5b63f1c7.js +++ b/docs/.vuepress/dist/assets/js/101.c0266c71.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{482:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tonibbles"}})]),t._v(" "),a("h2",{attrs:{id:"tonibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tonibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" toNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toNibbles")]),t._v("(input?: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/toNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/toNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": toNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" toNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x41")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([4, 1, 2, 0])")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{485:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tonibbles"}})]),t._v(" "),a("h2",{attrs:{id:"tonibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tonibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" toNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toNibbles")]),t._v("(input?: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/toNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/toNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": toNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" toNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x41")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([4, 1, 2, 0])")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/102.4ab0fdbb.js b/docs/.vuepress/dist/assets/js/102.bbdf1551.js similarity index 97% rename from docs/.vuepress/dist/assets/js/102.4ab0fdbb.js rename to docs/.vuepress/dist/assets/js/102.bbdf1551.js index 3e5587c8a..ab284fe06 100644 --- a/docs/.vuepress/dist/assets/js/102.4ab0fdbb.js +++ b/docs/.vuepress/dist/assets/js/102.bbdf1551.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{483:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-trie-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),a("p",[t._v("A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.")]),t._v(" "),a("p",[t._v("This is a JavaScript port of the "),a("a",{attrs:{href:"https://github.com/ethereum/py-trie",target:"_blank",rel:"noopener noreferrer"}},[t._v("Python Ethereum Trie"),a("OutboundLink")],1),t._v(" with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/trie-db\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Classes can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Trie "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-db'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Default export")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/trie-db/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{482:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-trie-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),a("p",[t._v("A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.")]),t._v(" "),a("p",[t._v("This is a JavaScript port of the "),a("a",{attrs:{href:"https://github.com/ethereum/py-trie",target:"_blank",rel:"noopener noreferrer"}},[t._v("Python Ethereum Trie"),a("OutboundLink")],1),t._v(" with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/trie-db\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Classes can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Trie "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-db'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Default export")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/trie-db/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/104.adec7c6b.js b/docs/.vuepress/dist/assets/js/104.08626032.js similarity index 96% rename from docs/.vuepress/dist/assets/js/104.adec7c6b.js rename to docs/.vuepress/dist/assets/js/104.08626032.js index 89a3d0421..34b7c728d 100644 --- a/docs/.vuepress/dist/assets/js/104.adec7c6b.js +++ b/docs/.vuepress/dist/assets/js/104.08626032.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{479:function(t,r,e){"use strict";e.r(r);var o=e(46),s=Object(o.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("Checkpoint")])]),t._v(" "),e("p",[t._v("↳ "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Checkpoint")]),t._v("(rootHash: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Checkpoint.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("Checkpoint.ts:7"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{479:function(t,r,e){"use strict";e.r(r);var o=e(46),s=Object(o.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("Checkpoint")])]),t._v(" "),e("p",[t._v("↳ "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Checkpoint")]),t._v("(rootHash: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Checkpoint.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("Checkpoint.ts:7"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/105.a4d47e9c.js b/docs/.vuepress/dist/assets/js/105.3756f026.js similarity index 95% rename from docs/.vuepress/dist/assets/js/105.a4d47e9c.js rename to docs/.vuepress/dist/assets/js/105.3756f026.js index 4ba1220f2..8fb932bfa 100644 --- a/docs/.vuepress/dist/assets/js/105.a4d47e9c.js +++ b/docs/.vuepress/dist/assets/js/105.3756f026.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{476:function(t,r,e){"use strict";e.r(r);var a=e(46),o=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-trie-db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),e("h2",{attrs:{id:"overview"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Re-implementation of a Patricia Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(": See "),e("a",{attrs:{href:"https://polkadot.js.org/api/common/examples/trie-db/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkadot-JS Common Trie-DB Examples"),e("OutboundLink")],1)]),t._v(" "),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("strong",[t._v("↳ Impl")])]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Impl")]),t._v("(db: "),e("em",[e("code",[t._v("TxDb")])]),t._v(", rootHash?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", codec?: "),e("em",[e("code",[t._v("Codec")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("p",[e("em",[t._v("Overrides "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")]),t._v("."),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Impl.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:38"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("db")]),t._v(" "),e("td",[e("code",[t._v("TxDb")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),e("td",[e("code",[t._v("Codec")])]),t._v(" "),e("td",[t._v("substrateCodec")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"db"}})]),t._v(" "),e("h2",{attrs:{id:"db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),e("p",[e("strong",[t._v("● db")]),t._v(": "),e("em",[e("code",[t._v("TxDb")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Impl.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:36"),e("OutboundLink")],1)])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{477:function(t,r,e){"use strict";e.r(r);var a=e(46),o=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-trie-db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),e("h2",{attrs:{id:"overview"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Re-implementation of a Patricia Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(": See "),e("a",{attrs:{href:"https://polkadot.js.org/api/common/examples/trie-db/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkadot-JS Common Trie-DB Examples"),e("OutboundLink")],1)]),t._v(" "),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("strong",[t._v("↳ Impl")])]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Impl")]),t._v("(db: "),e("em",[e("code",[t._v("TxDb")])]),t._v(", rootHash?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", codec?: "),e("em",[e("code",[t._v("Codec")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("p",[e("em",[t._v("Overrides "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")]),t._v("."),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:38"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("db")]),t._v(" "),e("td",[e("code",[t._v("TxDb")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),e("td",[e("code",[t._v("Codec")])]),t._v(" "),e("td",[t._v("substrateCodec")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"db"}})]),t._v(" "),e("h2",{attrs:{id:"db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),e("p",[e("strong",[t._v("● db")]),t._v(": "),e("em",[e("code",[t._v("TxDb")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:36"),e("OutboundLink")],1)])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/106.64e70bbc.js b/docs/.vuepress/dist/assets/js/106.9b5387d2.js similarity index 90% rename from docs/.vuepress/dist/assets/js/106.64e70bbc.js rename to docs/.vuepress/dist/assets/js/106.9b5387d2.js index 3560d08e1..dfeb9b547 100644 --- a/docs/.vuepress/dist/assets/js/106.64e70bbc.js +++ b/docs/.vuepress/dist/assets/js/106.9b5387d2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{477:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#extension"}},[t._v("EXTENSION")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 3")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extension"}})]),t._v(" "),r("h2",{attrs:{id:"extension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extension","aria-hidden":"true"}},[t._v("#")]),t._v(" EXTENSION")]),t._v(" "),r("p",[r("strong",[t._v("EXTENSION")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{476:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#extension"}},[t._v("EXTENSION")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 3")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extension"}})]),t._v(" "),r("h2",{attrs:{id:"extension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extension","aria-hidden":"true"}},[t._v("#")]),t._v(" EXTENSION")]),t._v(" "),r("p",[r("strong",[t._v("EXTENSION")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/107.76abff6f.js b/docs/.vuepress/dist/assets/js/107.ac0410cf.js similarity index 92% rename from docs/.vuepress/dist/assets/js/107.76abff6f.js rename to docs/.vuepress/dist/assets/js/107.ac0410cf.js index 39f35860f..664efa390 100644 --- a/docs/.vuepress/dist/assets/js/107.76abff6f.js +++ b/docs/.vuepress/dist/assets/js/107.ac0410cf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{474:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("TxDb")])]),t._v(" "),r("p",[r("strong",[t._v("↳ TrieDb")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"db"}})]),t._v(" "),r("h2",{attrs:{id:"db"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),r("p",[r("strong",[t._v("● db")]),t._v(": "),r("em",[r("code",[t._v("TxDb")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.close")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.del")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.drop")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.empty")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getroot"}})]),t._v(" "),r("h2",{attrs:{id:"getroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getroot","aria-hidden":"true"}},[t._v("#")]),t._v(" getRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getRoot")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.maintain")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.open")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.put")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.rename")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setroot"}})]),t._v(" "),r("h2",{attrs:{id:"setroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setroot","aria-hidden":"true"}},[t._v("#")]),t._v(" setRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setRoot")]),t._v("(rootHash: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("rootHash")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"snapshot"}})]),t._v(" "),r("h2",{attrs:{id:"snapshot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#snapshot","aria-hidden":"true"}},[t._v("#")]),t._v(" snapshot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("snapshot")]),t._v("(dest: "),r("em",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1),t._v(", fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("dest")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1)]),t._v(" "),r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from TxDb.transaction")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{474:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("TxDb")])]),t._v(" "),r("p",[r("strong",[t._v("↳ TrieDb")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"db"}})]),t._v(" "),r("h2",{attrs:{id:"db"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),r("p",[r("strong",[t._v("● db")]),t._v(": "),r("em",[r("code",[t._v("TxDb")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.close")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.del")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.drop")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.empty")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getroot"}})]),t._v(" "),r("h2",{attrs:{id:"getroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getroot","aria-hidden":"true"}},[t._v("#")]),t._v(" getRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getRoot")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.maintain")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.open")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.put")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.rename")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setroot"}})]),t._v(" "),r("h2",{attrs:{id:"setroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setroot","aria-hidden":"true"}},[t._v("#")]),t._v(" setRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setRoot")]),t._v("(rootHash: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("rootHash")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"snapshot"}})]),t._v(" "),r("h2",{attrs:{id:"snapshot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#snapshot","aria-hidden":"true"}},[t._v("#")]),t._v(" snapshot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("snapshot")]),t._v("(dest: "),r("em",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1),t._v(", fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("dest")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1)]),t._v(" "),r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from TxDb.transaction")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/109.3589d60e.js b/docs/.vuepress/dist/assets/js/109.f796e243.js similarity index 94% rename from docs/.vuepress/dist/assets/js/109.3589d60e.js rename to docs/.vuepress/dist/assets/js/109.f796e243.js index 2ddc93b4b..bb5b05912 100644 --- a/docs/.vuepress/dist/assets/js/109.3589d60e.js +++ b/docs/.vuepress/dist/assets/js/109.f796e243.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{471:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"constants"}})]),t._v(" "),a("h2",{attrs:{id:"constants"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constants","aria-hidden":"true"}},[t._v("#")]),t._v(" Constants")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Constants")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"default"}})]),t._v(" "),a("h2",{attrs:{id:"default"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default","aria-hidden":"true"}},[t._v("#")]),t._v(" default")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("default")]),t._v("(codec: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("object")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("object")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{471:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"constants"}})]),t._v(" "),a("h2",{attrs:{id:"constants"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constants","aria-hidden":"true"}},[t._v("#")]),t._v(" Constants")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Constants")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"default"}})]),t._v(" "),a("h2",{attrs:{id:"default"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default","aria-hidden":"true"}},[t._v("#")]),t._v(" default")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("default")]),t._v("(codec: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("object")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("object")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/11.90d60182.js b/docs/.vuepress/dist/assets/js/11.ea4175ac.js similarity index 94% rename from docs/.vuepress/dist/assets/js/11.90d60182.js rename to docs/.vuepress/dist/assets/js/11.ea4175ac.js index 3c97ca985..1c6570dee 100644 --- a/docs/.vuepress/dist/assets/js/11.90d60182.js +++ b/docs/.vuepress/dist/assets/js/11.ea4175ac.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{391:function(e,t,a){"use strict";a.r(t);var s=a(46),r=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"chainspec"}})]),e._v(" "),a("h2",{attrs:{id:"chainspec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#chainspec","aria-hidden":"true"}},[e._v("#")]),e._v(" Chainspec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Chainspec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/chainspec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{391:function(e,t,a){"use strict";a.r(t);var s=a(46),r=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"chainspec"}})]),e._v(" "),a("h2",{attrs:{id:"chainspec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#chainspec","aria-hidden":"true"}},[e._v("#")]),e._v(" Chainspec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Chainspec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/chainspec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/111.f2fb785c.js b/docs/.vuepress/dist/assets/js/111.b00ef71d.js similarity index 91% rename from docs/.vuepress/dist/assets/js/111.f2fb785c.js rename to docs/.vuepress/dist/assets/js/111.b00ef71d.js index 0367e9aa4..73e08e579 100644 --- a/docs/.vuepress/dist/assets/js/111.f2fb785c.js +++ b/docs/.vuepress/dist/assets/js/111.b00ef71d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{467:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{468:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/112.f0468900.js b/docs/.vuepress/dist/assets/js/112.3bdcdd17.js similarity index 94% rename from docs/.vuepress/dist/assets/js/112.f0468900.js rename to docs/.vuepress/dist/assets/js/112.3bdcdd17.js index e524aee24..d2abcfb46 100644 --- a/docs/.vuepress/dist/assets/js/112.f0468900.js +++ b/docs/.vuepress/dist/assets/js/112.3bdcdd17.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{468:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"enumerations"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1)]),e._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[e._v("TrieDb")])],1)]),e._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedpath"}})]),e._v(" "),r("h2",{attrs:{id:"encodedpath"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedpath","aria-hidden":"true"}},[e._v("#")]),e._v(" EncodedPath")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ EncodedPath")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"node"}})]),e._v(" "),r("h2",{attrs:{id:"node"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#node","aria-hidden":"true"}},[e._v("#")]),e._v(" Node")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Node")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodebranch"}})]),e._v(" "),r("h2",{attrs:{id:"nodebranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodebranch","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeBranch")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeBranch")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEmpty")]),e._v(": "),r("em",[r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencoded"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencoded"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencoded","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncoded")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncoded")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencodedorempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencodedorempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencodedorempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncodedOrEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncodedOrEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodekv"}})]),e._v(" "),r("h2",{attrs:{id:"nodekv"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodekv","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeKv")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeKv")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodenotempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodenotempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodenotempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeNotEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeNotEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{467:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"enumerations"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1)]),e._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[e._v("TrieDb")])],1)]),e._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedpath"}})]),e._v(" "),r("h2",{attrs:{id:"encodedpath"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedpath","aria-hidden":"true"}},[e._v("#")]),e._v(" EncodedPath")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ EncodedPath")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"node"}})]),e._v(" "),r("h2",{attrs:{id:"node"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#node","aria-hidden":"true"}},[e._v("#")]),e._v(" Node")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Node")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodebranch"}})]),e._v(" "),r("h2",{attrs:{id:"nodebranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodebranch","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeBranch")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeBranch")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEmpty")]),e._v(": "),r("em",[r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencoded"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencoded"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencoded","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncoded")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncoded")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencodedorempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencodedorempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencodedorempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncodedOrEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncodedOrEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodekv"}})]),e._v(" "),r("h2",{attrs:{id:"nodekv"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodekv","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeKv")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeKv")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodenotempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodenotempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodenotempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeNotEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeNotEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/113.57ac2f63.js b/docs/.vuepress/dist/assets/js/113.a1e71949.js similarity index 95% rename from docs/.vuepress/dist/assets/js/113.57ac2f63.js rename to docs/.vuepress/dist/assets/js/113.a1e71949.js index 5ece4139d..bdad21d06 100644 --- a/docs/.vuepress/dist/assets/js/113.57ac2f63.js +++ b/docs/.vuepress/dist/assets/js/113.a1e71949.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{465:function(e,t,r){"use strict";r.r(t);var o=r(46),n=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"isbranchnode"}})]),e._v(" "),r("h2",{attrs:{id:"isbranchnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isbranchnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isBranchNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isBranchNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isBranchNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Branch 17-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isemptynode"}})]),e._v(" "),r("h2",{attrs:{id:"isemptynode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isemptynode","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmptyNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isEmptyNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isEmptyNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is NULL")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isextensionnode"}})]),e._v(" "),r("h2",{attrs:{id:"isextensionnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isextensionnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isExtensionNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isExtensionNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isExtensionNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Extension 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"iskvnode"}})]),e._v(" "),r("h2",{attrs:{id:"iskvnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iskvnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isKvNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isKvNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isKvNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is not empty and contains a single key/value pair")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isleafnode"}})]),e._v(" "),r("h2",{attrs:{id:"isleafnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isleafnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isLeafNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isLeafNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isLeafNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Leaf 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{465:function(e,t,r){"use strict";r.r(t);var o=r(46),n=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"isbranchnode"}})]),e._v(" "),r("h2",{attrs:{id:"isbranchnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isbranchnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isBranchNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isBranchNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isBranchNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Branch 17-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isemptynode"}})]),e._v(" "),r("h2",{attrs:{id:"isemptynode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isemptynode","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmptyNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isEmptyNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isEmptyNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is NULL")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isextensionnode"}})]),e._v(" "),r("h2",{attrs:{id:"isextensionnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isextensionnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isExtensionNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isExtensionNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isExtensionNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Extension 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"iskvnode"}})]),e._v(" "),r("h2",{attrs:{id:"iskvnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iskvnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isKvNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isKvNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isKvNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is not empty and contains a single key/value pair")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isleafnode"}})]),e._v(" "),r("h2",{attrs:{id:"isleafnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isleafnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isLeafNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isLeafNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isLeafNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Leaf 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/114.ef806fbe.js b/docs/.vuepress/dist/assets/js/114.e6b445cc.js similarity index 94% rename from docs/.vuepress/dist/assets/js/114.ef806fbe.js rename to docs/.vuepress/dist/assets/js/114.e6b445cc.js index 7f6f92617..126f528a0 100644 --- a/docs/.vuepress/dist/assets/js/114.ef806fbe.js +++ b/docs/.vuepress/dist/assets/js/114.e6b445cc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{464:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"computeextensionkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeextensionkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeextensionkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeExtensionKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeExtensionKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"computeleafkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeleafkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeleafkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeLeafKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeLeafKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"consumecommonprefix"}})]),t._v(" "),r("h2",{attrs:{id:"consumecommonprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#consumecommonprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" consumeCommonPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("consumeCommonPrefix")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getcommonprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"getcommonprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getcommonprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" getCommonPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getCommonPrefixLength")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keyequals"}})]),t._v(" "),r("h2",{attrs:{id:"keyequals"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyequals","aria-hidden":"true"}},[t._v("#")]),t._v(" keyEquals")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyEquals")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", test: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("test")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keystartswith"}})]),t._v(" "),r("h2",{attrs:{id:"keystartswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keystartswith","aria-hidden":"true"}},[t._v("#")]),t._v(" keyStartsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyStartsWith")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", partial: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("partial")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{464:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"computeextensionkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeextensionkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeextensionkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeExtensionKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeExtensionKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"computeleafkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeleafkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeleafkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeLeafKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeLeafKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"consumecommonprefix"}})]),t._v(" "),r("h2",{attrs:{id:"consumecommonprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#consumecommonprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" consumeCommonPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("consumeCommonPrefix")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getcommonprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"getcommonprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getcommonprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" getCommonPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getCommonPrefixLength")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keyequals"}})]),t._v(" "),r("h2",{attrs:{id:"keyequals"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyequals","aria-hidden":"true"}},[t._v("#")]),t._v(" keyEquals")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyEquals")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", test: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("test")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keystartswith"}})]),t._v(" "),r("h2",{attrs:{id:"keystartswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keystartswith","aria-hidden":"true"}},[t._v("#")]),t._v(" keyStartsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyStartsWith")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", partial: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("partial")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/115.c2bb95ce.js b/docs/.vuepress/dist/assets/js/115.62463929.js similarity index 95% rename from docs/.vuepress/dist/assets/js/115.c2bb95ce.js rename to docs/.vuepress/dist/assets/js/115.62463929.js index a40a4aa06..cfe8fd4c6 100644 --- a/docs/.vuepress/dist/assets/js/115.c2bb95ce.js +++ b/docs/.vuepress/dist/assets/js/115.62463929.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{462:function(e,t,o){"use strict";o.r(t);var r=o(46),d=Object(r.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),o("p",[o("a",{attrs:{id:"decodenode"}})]),e._v(" "),o("h2",{attrs:{id:"decodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("decodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", encoded: "),o("em",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:30"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("encoded")]),e._v(" "),o("td",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"encodenode"}})]),e._v(" "),o("h2",{attrs:{id:"encodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#encodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("encodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:46"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getnodetype"}})]),e._v(" "),o("h2",{attrs:{id:"getnodetype"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#getnodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" getNodeType")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getNodeType")]),e._v("(node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:13"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{462:function(e,t,o){"use strict";o.r(t);var r=o(46),d=Object(r.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),o("p",[o("a",{attrs:{id:"decodenode"}})]),e._v(" "),o("h2",{attrs:{id:"decodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("decodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", encoded: "),o("em",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:30"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("encoded")]),e._v(" "),o("td",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"encodenode"}})]),e._v(" "),o("h2",{attrs:{id:"encodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#encodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("encodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:46"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getnodetype"}})]),e._v(" "),o("h2",{attrs:{id:"getnodetype"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#getnodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" getNodeType")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getNodeType")]),e._v("(node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:13"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/118.5672cbf8.js b/docs/.vuepress/dist/assets/js/118.cc136900.js similarity index 91% rename from docs/.vuepress/dist/assets/js/118.5672cbf8.js rename to docs/.vuepress/dist/assets/js/118.cc136900.js index f54c5ff1b..112484c20 100644 --- a/docs/.vuepress/dist/assets/js/118.5672cbf8.js +++ b/docs/.vuepress/dist/assets/js/118.cc136900.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{418:function(t,e,r){"use strict";r.r(e);var v=r(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"buildtrie"}})]),t._v(" "),r("h2",{attrs:{id:"buildtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buildtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" buildTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("buildTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(", cursor?: "),r("em",[r("code",[t._v("number")])]),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v(", stream?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/buildTrie.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("buildTrie.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" cursor")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("0")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" stream")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("DEFAULT_STREAM")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{458:function(t,e,r){"use strict";r.r(e);var v=r(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"buildtrie"}})]),t._v(" "),r("h2",{attrs:{id:"buildtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buildtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" buildTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("buildTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(", cursor?: "),r("em",[r("code",[t._v("number")])]),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v(", stream?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/buildTrie.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("buildTrie.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" cursor")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("0")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" stream")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("DEFAULT_STREAM")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/119.5578e267.js b/docs/.vuepress/dist/assets/js/119.294e232e.js similarity index 79% rename from docs/.vuepress/dist/assets/js/119.5578e267.js rename to docs/.vuepress/dist/assets/js/119.294e232e.js index 667c90c71..a72c97da2 100644 --- a/docs/.vuepress/dist/assets/js/119.5578e267.js +++ b/docs/.vuepress/dist/assets/js/119.294e232e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{455:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{453:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/120.d64edc35.js b/docs/.vuepress/dist/assets/js/120.83f82f71.js similarity index 97% rename from docs/.vuepress/dist/assets/js/120.d64edc35.js rename to docs/.vuepress/dist/assets/js/120.83f82f71.js index 11df3305c..3fbf5dff2 100644 --- a/docs/.vuepress/dist/assets/js/120.d64edc35.js +++ b/docs/.vuepress/dist/assets/js/120.83f82f71.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{453:function(t,a,s){"use strict";s.r(a);var r=s(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"trieroot"}})]),t._v(" "),s("h2",{attrs:{id:"trieroot"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#trieroot","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRoot")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("trieRoot")]),t._v("(input: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),s("em",[s("code",[t._v("Codec")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/trieRoot.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRoot.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": trieRoot")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied pairs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From an "),s("code",[t._v("Array<{k: Uint8Array, v: Uint8Array}>")]),t._v(" input, calculate the triehash and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRoot "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRoot")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n k"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n v"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),s("td",[s("code",[t._v("Codec")])]),t._v(" "),s("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{455:function(t,a,s){"use strict";s.r(a);var r=s(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"trieroot"}})]),t._v(" "),s("h2",{attrs:{id:"trieroot"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#trieroot","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRoot")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("trieRoot")]),t._v("(input: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),s("em",[s("code",[t._v("Codec")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRoot.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRoot.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": trieRoot")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied pairs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From an "),s("code",[t._v("Array<{k: Uint8Array, v: Uint8Array}>")]),t._v(" input, calculate the triehash and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRoot "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRoot")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n k"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n v"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),s("td",[s("code",[t._v("Codec")])]),t._v(" "),s("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/121.486102e5.js b/docs/.vuepress/dist/assets/js/121.b9ffa863.js similarity index 98% rename from docs/.vuepress/dist/assets/js/121.486102e5.js rename to docs/.vuepress/dist/assets/js/121.b9ffa863.js index a28059d3a..d67df6653 100644 --- a/docs/.vuepress/dist/assets/js/121.486102e5.js +++ b/docs/.vuepress/dist/assets/js/121.b9ffa863.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{452:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"trierootordered"}})]),t._v(" "),a("h2",{attrs:{id:"trierootordered"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#trierootordered","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRootOrdered")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("trieRootOrdered")]),t._v("(input: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(", codec?: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/trieRootOrdered.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRootOrdered.ts:30"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": trieRootOrdered")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Array")]),t._v(" input, calculate the ordered triehash and return the result as a "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRootOrdered "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRootOrdered")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doe'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'reindeer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])]),t._v(" "),a("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{452:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"trierootordered"}})]),t._v(" "),a("h2",{attrs:{id:"trierootordered"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#trierootordered","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRootOrdered")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("trieRootOrdered")]),t._v("(input: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(", codec?: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRootOrdered.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRootOrdered.ts:30"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": trieRootOrdered")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Array")]),t._v(" input, calculate the ordered triehash and return the result as a "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRootOrdered "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRootOrdered")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doe'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'reindeer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])]),t._v(" "),a("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/122.5ef5212c.js b/docs/.vuepress/dist/assets/js/122.4129636d.js similarity index 94% rename from docs/.vuepress/dist/assets/js/122.5ef5212c.js rename to docs/.vuepress/dist/assets/js/122.4129636d.js index 7ac7174fd..a1bbbb1e7 100644 --- a/docs/.vuepress/dist/assets/js/122.5ef5212c.js +++ b/docs/.vuepress/dist/assets/js/122.4129636d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{450:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"triepair"}})]),t._v(" "),a("h2",{attrs:{id:"triepair"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#triepair","aria-hidden":"true"}},[t._v("#")]),t._v(" TriePair")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ TriePair")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{450:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"triepair"}})]),t._v(" "),a("h2",{attrs:{id:"triepair"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#triepair","aria-hidden":"true"}},[t._v("#")]),t._v(" TriePair")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ TriePair")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/123.28868041.js b/docs/.vuepress/dist/assets/js/123.390c7af8.js similarity index 96% rename from docs/.vuepress/dist/assets/js/123.28868041.js rename to docs/.vuepress/dist/assets/js/123.390c7af8.js index ba737bda3..520df0469 100644 --- a/docs/.vuepress/dist/assets/js/123.28868041.js +++ b/docs/.vuepress/dist/assets/js/123.390c7af8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{449:function(t,e,r){"use strict";r.r(e);var a=r(46),_=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"unhashedtrie"}})]),t._v(" "),r("h2",{attrs:{id:"unhashedtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unhashedtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" unhashedTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unhashedTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/unhashedTrie.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("unhashedTrie.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{449:function(t,e,r){"use strict";r.r(e);var a=r(46),_=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"unhashedtrie"}})]),t._v(" "),r("h2",{attrs:{id:"unhashedtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unhashedtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" unhashedTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unhashedTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/unhashedTrie.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("unhashedTrie.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/126.41204771.js b/docs/.vuepress/dist/assets/js/126.d301e959.js similarity index 98% rename from docs/.vuepress/dist/assets/js/126.41204771.js rename to docs/.vuepress/dist/assets/js/126.d301e959.js index 0ee7d9f3b..8f4eb8849 100644 --- a/docs/.vuepress/dist/assets/js/126.41204771.js +++ b/docs/.vuepress/dist/assets/js/126.d301e959.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{444:function(t,e,a){"use strict";a.r(e);var s=a(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"blake2ashex"}})]),t._v(" "),a("h2",{attrs:{id:"blake2ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#blake2ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("blake2AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/asHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asHex.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": blake2AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From a "),a("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string with the specified "),a("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xba80a53f981c4d0d")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("256")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{444:function(t,e,a){"use strict";a.r(e);var s=a(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"blake2ashex"}})]),t._v(" "),a("h2",{attrs:{id:"blake2ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#blake2ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("blake2AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asHex.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": blake2AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From a "),a("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string with the specified "),a("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xba80a53f981c4d0d")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("256")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/127.59242d3e.js b/docs/.vuepress/dist/assets/js/127.d0a7193e.js similarity index 98% rename from docs/.vuepress/dist/assets/js/127.59242d3e.js rename to docs/.vuepress/dist/assets/js/127.d0a7193e.js index 1a1580706..847430933 100644 --- a/docs/.vuepress/dist/assets/js/127.59242d3e.js +++ b/docs/.vuepress/dist/assets/js/127.d0a7193e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{443:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2asu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2asu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2AsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2AsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b u8a from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a u8a with the specified "),e("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("256")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{443:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2asu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2asu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2AsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2AsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b u8a from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a u8a with the specified "),e("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("256")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/128.65e280b7.js b/docs/.vuepress/dist/assets/js/128.f42a132c.js similarity index 98% rename from docs/.vuepress/dist/assets/js/128.65e280b7.js rename to docs/.vuepress/dist/assets/js/128.f42a132c.js index 777b520e4..284da385a 100644 --- a/docs/.vuepress/dist/assets/js/128.65e280b7.js +++ b/docs/.vuepress/dist/assets/js/128.f42a132c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{441:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2bashex"}})]),t._v(" "),e("h2",{attrs:{id:"blake2bashex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2bashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsHex")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asHex.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex string from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923'")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{441:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2bashex"}})]),t._v(" "),e("h2",{attrs:{id:"blake2bashex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2bashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsHex")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asHex.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex string from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923'")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/129.459d9755.js b/docs/.vuepress/dist/assets/js/129.4d3a6550.js similarity index 98% rename from docs/.vuepress/dist/assets/js/129.459d9755.js rename to docs/.vuepress/dist/assets/js/129.4d3a6550.js index 356d92e16..def990688 100644 --- a/docs/.vuepress/dist/assets/js/129.459d9755.js +++ b/docs/.vuepress/dist/assets/js/129.4d3a6550.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{440:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2basu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2basu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2basu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asU8a.ts:22"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982')")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("null")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{440:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2basu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2basu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2basu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asU8a.ts:22"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982')")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("null")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/130.6c0d0217.js b/docs/.vuepress/dist/assets/js/130.d0dd4775.js similarity index 98% rename from docs/.vuepress/dist/assets/js/130.6c0d0217.js rename to docs/.vuepress/dist/assets/js/130.d0dd4775.js index 2c3d62d55..9b9f6cbe2 100644 --- a/docs/.vuepress/dist/assets/js/130.6c0d0217.js +++ b/docs/.vuepress/dist/assets/js/130.d0dd4775.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{438:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"keccakashex"}})]),t._v(" "),a("h2",{attrs:{id:"keccakashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keccakashex","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("keccakAsHex")]),t._v("(value: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/keccak/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": keccakAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a keccak hex string from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),a("code",[t._v("0x")]),t._v(" prefixed hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{438:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"keccakashex"}})]),t._v(" "),a("h2",{attrs:{id:"keccakashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keccakashex","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("keccakAsHex")]),t._v("(value: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": keccakAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a keccak hex string from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),a("code",[t._v("0x")]),t._v(" prefixed hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/131.feac53dd.js b/docs/.vuepress/dist/assets/js/131.5391d115.js similarity index 98% rename from docs/.vuepress/dist/assets/js/131.feac53dd.js rename to docs/.vuepress/dist/assets/js/131.5391d115.js index 73ae33cc7..2a913c487 100644 --- a/docs/.vuepress/dist/assets/js/131.feac53dd.js +++ b/docs/.vuepress/dist/assets/js/131.5391d115.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{437:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"keccakasu8a"}})]),t._v(" "),e("h2",{attrs:{id:"keccakasu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#keccakasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("keccakAsU8a")]),t._v("(value: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/keccak/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": keccakAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a keccak Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From either a "),e("code",[t._v("string")]),t._v(" or a "),e("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("value")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{437:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"keccakasu8a"}})]),t._v(" "),e("h2",{attrs:{id:"keccakasu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#keccakasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("keccakAsU8a")]),t._v("(value: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": keccakAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a keccak Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From either a "),e("code",[t._v("string")]),t._v(" or a "),e("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("value")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/132.5b328f06.js b/docs/.vuepress/dist/assets/js/132.3c1a5562.js similarity index 96% rename from docs/.vuepress/dist/assets/js/132.5b328f06.js rename to docs/.vuepress/dist/assets/js/132.3c1a5562.js index f3240b9bc..d61c87a68 100644 --- a/docs/.vuepress/dist/assets/js/132.5b328f06.js +++ b/docs/.vuepress/dist/assets/js/132.3c1a5562.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{434:function(t,e,n){"use strict";n.r(e);var a=n(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"mnemonicgenerate"}})]),t._v(" "),n("h2",{attrs:{id:"mnemonicgenerate"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicgenerate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicGenerate")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("mnemonicGenerate")]),t._v("(strength?: "),n("em",[n("code",[t._v("Strength")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/generate.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/generate.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": mnemonicGenerate")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a valid mnemonic string using using "),n("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),n("OutboundLink")],1),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" strength")]),t._v(" "),n("td",[n("code",[t._v("Strength")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{435:function(t,e,n){"use strict";n.r(e);var a=n(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"mnemonicgenerate"}})]),t._v(" "),n("h2",{attrs:{id:"mnemonicgenerate"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicgenerate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicGenerate")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("mnemonicGenerate")]),t._v("(strength?: "),n("em",[n("code",[t._v("Strength")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/generate.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/generate.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": mnemonicGenerate")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a valid mnemonic string using using "),n("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),n("OutboundLink")],1),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" strength")]),t._v(" "),n("td",[n("code",[t._v("Strength")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/133.fa52f3b8.js b/docs/.vuepress/dist/assets/js/133.4d7cdad5.js similarity index 91% rename from docs/.vuepress/dist/assets/js/133.fa52f3b8.js rename to docs/.vuepress/dist/assets/js/133.4d7cdad5.js index f333dd656..83d2ba817 100644 --- a/docs/.vuepress/dist/assets/js/133.fa52f3b8.js +++ b/docs/.vuepress/dist/assets/js/133.4d7cdad5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{435:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tosecret"}})]),t._v(" "),r("h2",{attrs:{id:"tosecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tosecret","aria-hidden":"true"}},[t._v("#")]),t._v(" toSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toSecret")]),t._v("(mnemonic: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/toSecret.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSecret.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("mnemonic")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{434:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tosecret"}})]),t._v(" "),r("h2",{attrs:{id:"tosecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tosecret","aria-hidden":"true"}},[t._v("#")]),t._v(" toSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toSecret")]),t._v("(mnemonic: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSecret.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSecret.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("mnemonic")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/134.5125e134.js b/docs/.vuepress/dist/assets/js/134.175e14ba.js similarity index 98% rename from docs/.vuepress/dist/assets/js/134.5125e134.js rename to docs/.vuepress/dist/assets/js/134.175e14ba.js index 602db90de..69ff9f50f 100644 --- a/docs/.vuepress/dist/assets/js/134.5125e134.js +++ b/docs/.vuepress/dist/assets/js/134.175e14ba.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{432:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"toseed"}})]),t._v(" "),s("h2",{attrs:{id:"toseed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#toseed","aria-hidden":"true"}},[t._v("#")]),t._v(" toSeed")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toSeed")]),t._v("(mnemonic: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/toSeed.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSeed.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": toSeed")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a valid seed from a mnemonic input")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicToSeed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("isValidMnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Seed generated from mnemonic: ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicToSeed")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" u8a\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("mnemonic")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{432:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"toseed"}})]),t._v(" "),s("h2",{attrs:{id:"toseed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#toseed","aria-hidden":"true"}},[t._v("#")]),t._v(" toSeed")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toSeed")]),t._v("(mnemonic: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSeed.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSeed.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": toSeed")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a valid seed from a mnemonic input")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicToSeed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("isValidMnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Seed generated from mnemonic: ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicToSeed")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" u8a\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("mnemonic")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/135.e4669c01.js b/docs/.vuepress/dist/assets/js/135.6c143002.js similarity index 98% rename from docs/.vuepress/dist/assets/js/135.e4669c01.js rename to docs/.vuepress/dist/assets/js/135.6c143002.js index 010cc6b40..17c67af85 100644 --- a/docs/.vuepress/dist/assets/js/135.e4669c01.js +++ b/docs/.vuepress/dist/assets/js/135.6c143002.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{431:function(t,n,a){"use strict";a.r(n);var e=a(46),s=Object(e.a)({},function(){var t=this,n=t.$createElement,a=t._self._c||n;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"mnemonicvalidate"}})]),t._v(" "),a("h2",{attrs:{id:"mnemonicvalidate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicvalidate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicValidate")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("mnemonicValidate")]),t._v("(mnemonic: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/validate.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/validate.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": mnemonicValidate")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Validates a mnemonic input using "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("mnemonic")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{431:function(t,n,a){"use strict";a.r(n);var e=a(46),s=Object(e.a)({},function(){var t=this,n=t.$createElement,a=t._self._c||n;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"mnemonicvalidate"}})]),t._v(" "),a("h2",{attrs:{id:"mnemonicvalidate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicvalidate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicValidate")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("mnemonicValidate")]),t._v("(mnemonic: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/validate.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/validate.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": mnemonicValidate")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Validates a mnemonic input using "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("mnemonic")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/136.86de8385.js b/docs/.vuepress/dist/assets/js/136.78afd8ff.js similarity index 98% rename from docs/.vuepress/dist/assets/js/136.86de8385.js rename to docs/.vuepress/dist/assets/js/136.78afd8ff.js index 59f4dde65..80e93c4b5 100644 --- a/docs/.vuepress/dist/assets/js/136.86de8385.js +++ b/docs/.vuepress/dist/assets/js/136.78afd8ff.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{429:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"nacldecrypt"}})]),t._v(" "),n("h2",{attrs:{id:"nacldecrypt"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#nacldecrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclDecrypt")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("naclDecrypt")]),t._v("(encrypted: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", nonce: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", secret: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/decrypt.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/decrypt.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": naclDecrypt")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Decrypts a message using the supplied secretKey and nonce")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns an decrypted message, using the "),n("code",[t._v("secret")]),t._v(" and "),n("code",[t._v("nonce")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclDecrypt "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclDecrypt")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("encrypted")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("nonce")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("secret")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{429:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"nacldecrypt"}})]),t._v(" "),n("h2",{attrs:{id:"nacldecrypt"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#nacldecrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclDecrypt")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("naclDecrypt")]),t._v("(encrypted: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", nonce: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", secret: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/decrypt.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/decrypt.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": naclDecrypt")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Decrypts a message using the supplied secretKey and nonce")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns an decrypted message, using the "),n("code",[t._v("secret")]),t._v(" and "),n("code",[t._v("nonce")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclDecrypt "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclDecrypt")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("encrypted")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("nonce")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("secret")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/137.510af033.js b/docs/.vuepress/dist/assets/js/137.347ff027.js similarity index 98% rename from docs/.vuepress/dist/assets/js/137.510af033.js rename to docs/.vuepress/dist/assets/js/137.347ff027.js index 3a1313bb1..9b33aba3a 100644 --- a/docs/.vuepress/dist/assets/js/137.510af033.js +++ b/docs/.vuepress/dist/assets/js/137.347ff027.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{428:function(t,n,e){"use strict";e.r(n);var a=e(46),s=Object(a.a)({},function(){var t=this,n=t.$createElement,e=t._self._c||n;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclencrypt"}})]),t._v(" "),e("h2",{attrs:{id:"naclencrypt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclencrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclEncrypt")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclEncrypt")]),t._v("(message: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", secret: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", nonce?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Encrypted")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/encrypt.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/encrypt.ts:28"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclEncrypt")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Encrypts a message using the supplied secretKey and nonce")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns an encrypted message, using the "),e("code",[t._v("secretKey")]),t._v(" and "),e("code",[t._v("nonce")]),t._v(". If the "),e("code",[t._v("nonce")]),t._v(" was not supplied, a random value is generated.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclEncrypt "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclEncrypt")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("message")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("secret")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" nonce")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("randomAsU8a(24)")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Encrypted")])]),t._v(" "),e("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{428:function(t,n,e){"use strict";e.r(n);var a=e(46),s=Object(a.a)({},function(){var t=this,n=t.$createElement,e=t._self._c||n;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclencrypt"}})]),t._v(" "),e("h2",{attrs:{id:"naclencrypt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclencrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclEncrypt")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclEncrypt")]),t._v("(message: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", secret: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", nonce?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Encrypted")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/encrypt.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/encrypt.ts:28"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclEncrypt")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Encrypts a message using the supplied secretKey and nonce")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns an encrypted message, using the "),e("code",[t._v("secretKey")]),t._v(" and "),e("code",[t._v("nonce")]),t._v(". If the "),e("code",[t._v("nonce")]),t._v(" was not supplied, a random value is generated.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclEncrypt "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclEncrypt")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("message")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("secret")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" nonce")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("randomAsU8a(24)")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Encrypted")])]),t._v(" "),e("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/138.69d20c7d.js b/docs/.vuepress/dist/assets/js/138.df837b4b.js similarity index 97% rename from docs/.vuepress/dist/assets/js/138.69d20c7d.js rename to docs/.vuepress/dist/assets/js/138.df837b4b.js index 94492f4b7..448bf2cf7 100644 --- a/docs/.vuepress/dist/assets/js/138.69d20c7d.js +++ b/docs/.vuepress/dist/assets/js/138.df837b4b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{426:function(t,a,e){"use strict";e.r(a);var r=e(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclkeypairfromrandom"}})]),t._v(" "),e("h2",{attrs:{id:"naclkeypairfromrandom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromrandom","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromRandom")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclKeypairFromRandom")]),t._v("(): "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromRandom.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclKeypairFromRandom")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns a new generate object containing a "),e("code",[t._v("publicKey")]),t._v(" & "),e("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromRandom "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromRandom")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{426:function(t,a,e){"use strict";e.r(a);var r=e(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclkeypairfromrandom"}})]),t._v(" "),e("h2",{attrs:{id:"naclkeypairfromrandom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromrandom","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromRandom")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclKeypairFromRandom")]),t._v("(): "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromRandom.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclKeypairFromRandom")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns a new generate object containing a "),e("code",[t._v("publicKey")]),t._v(" & "),e("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromRandom "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromRandom")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/139.fa647ca6.js b/docs/.vuepress/dist/assets/js/139.65c63374.js similarity index 98% rename from docs/.vuepress/dist/assets/js/139.fa647ca6.js rename to docs/.vuepress/dist/assets/js/139.65c63374.js index 8b31b9c02..047f790e4 100644 --- a/docs/.vuepress/dist/assets/js/139.fa647ca6.js +++ b/docs/.vuepress/dist/assets/js/139.65c63374.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{425:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromsecret"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromsecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromsecret","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromSecret")]),t._v("(secret: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromSecret.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromSecret")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromSecret "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromSecret")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("secret")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{425:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromsecret"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromsecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromsecret","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromSecret")]),t._v("(secret: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromSecret.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromSecret")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromSecret "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromSecret")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("secret")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/14.18f90bb4.js b/docs/.vuepress/dist/assets/js/14.cdf62cb8.js similarity index 97% rename from docs/.vuepress/dist/assets/js/14.18f90bb4.js rename to docs/.vuepress/dist/assets/js/14.cdf62cb8.js index 39a9c689d..19e990be8 100644 --- a/docs/.vuepress/dist/assets/js/14.18f90bb4.js +++ b/docs/.vuepress/dist/assets/js/14.cdf62cb8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{473:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": DiskDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Disk database using LruDb (for caching with FileFlatDb) and extending TransactionDb. Note that LruDB uses the "),n("a",{attrs:{href:"https://www.npmjs.com/package/lru_map",target:"_blank",rel:"noopener noreferrer"}},[t._v("Least Recently Used (LRU) cache algorithm"),n("OutboundLink")],1)]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" DiskDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Disk'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat diskDb instance that wraps LruDb with backing and Lru cache")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" diskDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("DiskDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat txDb instance that uses diskDb")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the disk db backing database. Clears the Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in disk db backing and also in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from disk db. Returns cached value if key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cache, otherwise returns backing value for key and stores")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this latest retrieved key/value pair in Lru cache")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from disk db backing and set the key to null in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from diskDb db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the diskDb database and clear Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ DiskDb")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new DiskDb")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", name: "),n("em",[n("code",[t._v("string")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/Disk.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Disk.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("name")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{418:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": DiskDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Disk database using LruDb (for caching with FileFlatDb) and extending TransactionDb. Note that LruDB uses the "),n("a",{attrs:{href:"https://www.npmjs.com/package/lru_map",target:"_blank",rel:"noopener noreferrer"}},[t._v("Least Recently Used (LRU) cache algorithm"),n("OutboundLink")],1)]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" DiskDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Disk'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat diskDb instance that wraps LruDb with backing and Lru cache")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" diskDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("DiskDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat txDb instance that uses diskDb")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the disk db backing database. Clears the Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in disk db backing and also in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from disk db. Returns cached value if key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cache, otherwise returns backing value for key and stores")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this latest retrieved key/value pair in Lru cache")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from disk db backing and set the key to null in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from diskDb db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the diskDb database and clear Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ DiskDb")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new DiskDb")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", name: "),n("em",[n("code",[t._v("string")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Disk.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Disk.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("name")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/140.55742aa6.js b/docs/.vuepress/dist/assets/js/140.51d65b0e.js similarity index 98% rename from docs/.vuepress/dist/assets/js/140.55742aa6.js rename to docs/.vuepress/dist/assets/js/140.51d65b0e.js index b6687db1c..049b5229b 100644 --- a/docs/.vuepress/dist/assets/js/140.55742aa6.js +++ b/docs/.vuepress/dist/assets/js/140.51d65b0e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{423:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),a("p",[a("a",{attrs:{id:"naclkeypairfromseed"}})]),e._v(" "),a("h2",{attrs:{id:"naclkeypairfromseed"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" naclKeypairFromSeed")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("naclKeypairFromSeed")]),e._v("(seed: "),a("em",[a("code",[e._v("Uint8Array")])]),e._v("): "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("nacl/keypair/fromSeed.ts:23"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("em",[a("strong",[e._v("name")])]),e._v(": naclKeypairFromSeed")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("summary")])]),e._v(": Creates a new public/secret keypair from a seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("description")])]),e._v(": Returns a object containing a "),a("code",[e._v("publicKey")]),e._v(" & "),a("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("example")])]),e._v(":")]),e._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("import")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" naclKeypairFromSeed "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("from")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("naclKeypairFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// => { secretKey: [...], publicKey: [...] }")]),e._v("\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br"),a("span",{staticClass:"line-number"},[e._v("3")]),a("br")])]),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("seed")]),e._v(" "),a("td",[a("code",[e._v("Uint8Array")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{423:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),a("p",[a("a",{attrs:{id:"naclkeypairfromseed"}})]),e._v(" "),a("h2",{attrs:{id:"naclkeypairfromseed"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" naclKeypairFromSeed")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("naclKeypairFromSeed")]),e._v("(seed: "),a("em",[a("code",[e._v("Uint8Array")])]),e._v("): "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("nacl/keypair/fromSeed.ts:23"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("em",[a("strong",[e._v("name")])]),e._v(": naclKeypairFromSeed")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("summary")])]),e._v(": Creates a new public/secret keypair from a seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("description")])]),e._v(": Returns a object containing a "),a("code",[e._v("publicKey")]),e._v(" & "),a("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("example")])]),e._v(":")]),e._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("import")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" naclKeypairFromSeed "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("from")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("naclKeypairFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// => { secretKey: [...], publicKey: [...] }")]),e._v("\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br"),a("span",{staticClass:"line-number"},[e._v("3")]),a("br")])]),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("seed")]),e._v(" "),a("td",[a("code",[e._v("Uint8Array")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/141.b2638bc3.js b/docs/.vuepress/dist/assets/js/141.f9a51cbf.js similarity index 94% rename from docs/.vuepress/dist/assets/js/141.b2638bc3.js rename to docs/.vuepress/dist/assets/js/141.f9a51cbf.js index e9e9e8040..ce70a58c5 100644 --- a/docs/.vuepress/dist/assets/js/141.b2638bc3.js +++ b/docs/.vuepress/dist/assets/js/141.f9a51cbf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{422:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromstring"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromstring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromstring","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromString")]),t._v("(value: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromString.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromString.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromString")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a string.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied string. The string is hashed and the value used as the input seed.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromString "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromString")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{419:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromstring"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromstring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromstring","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromString")]),t._v("(value: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromString.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromString.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromString")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a string.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied string. The string is hashed and the value used as the input seed.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromString "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromString")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/142.c120c24b.js b/docs/.vuepress/dist/assets/js/142.6d88dd71.js similarity index 94% rename from docs/.vuepress/dist/assets/js/142.c120c24b.js rename to docs/.vuepress/dist/assets/js/142.6d88dd71.js index e1aef1c7e..362450681 100644 --- a/docs/.vuepress/dist/assets/js/142.c120c24b.js +++ b/docs/.vuepress/dist/assets/js/142.6d88dd71.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{420:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclsign"}})]),t._v(" "),a("h2",{attrs:{id:"naclsign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclsign","aria-hidden":"true"}},[t._v("#")]),t._v(" naclSign")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclSign")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", __namedParameters: "),a("em",[a("code",[t._v("object")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/sign.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/sign.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Signs a message using the supplied secretKey")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns message signature of "),a("code",[t._v("message")]),t._v(", using the "),a("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclSign "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclSign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("__namedParameters")]),t._v(" "),a("td",[a("code",[t._v("object")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{422:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclsign"}})]),t._v(" "),a("h2",{attrs:{id:"naclsign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclsign","aria-hidden":"true"}},[t._v("#")]),t._v(" naclSign")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclSign")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", __namedParameters: "),a("em",[a("code",[t._v("object")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/sign.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/sign.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Signs a message using the supplied secretKey")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns message signature of "),a("code",[t._v("message")]),t._v(", using the "),a("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclSign "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclSign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("__namedParameters")]),t._v(" "),a("td",[a("code",[t._v("object")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/143.727a82f3.js b/docs/.vuepress/dist/assets/js/143.4026d731.js similarity index 97% rename from docs/.vuepress/dist/assets/js/143.727a82f3.js rename to docs/.vuepress/dist/assets/js/143.4026d731.js index ba9d30d62..56cd47cd4 100644 --- a/docs/.vuepress/dist/assets/js/143.727a82f3.js +++ b/docs/.vuepress/dist/assets/js/143.4026d731.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{417:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclverify"}})]),t._v(" "),a("h2",{attrs:{id:"naclverify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclverify","aria-hidden":"true"}},[t._v("#")]),t._v(" naclVerify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclVerify")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", signature: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", publicKey: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/verify.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/verify.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Verifies the signature on the supplied message.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Verifies the "),a("code",[t._v("signature")]),t._v(" on "),a("code",[t._v("message")]),t._v(" with the supplied "),a("code",[t._v("plublicKey")]),t._v(". Returns "),a("code",[t._v("true")]),t._v(" on sucess, "),a("code",[t._v("false")]),t._v(" otherwise.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclVerify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclVerify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true/false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("signature")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("publicKey")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{420:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclverify"}})]),t._v(" "),a("h2",{attrs:{id:"naclverify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclverify","aria-hidden":"true"}},[t._v("#")]),t._v(" naclVerify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclVerify")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", signature: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", publicKey: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/verify.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/verify.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Verifies the signature on the supplied message.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Verifies the "),a("code",[t._v("signature")]),t._v(" on "),a("code",[t._v("message")]),t._v(" with the supplied "),a("code",[t._v("plublicKey")]),t._v(". Returns "),a("code",[t._v("true")]),t._v(" on sucess, "),a("code",[t._v("false")]),t._v(" otherwise.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclVerify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclVerify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true/false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("signature")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("publicKey")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/144.5dce0394.js b/docs/.vuepress/dist/assets/js/144.22f9176e.js similarity index 95% rename from docs/.vuepress/dist/assets/js/144.5dce0394.js rename to docs/.vuepress/dist/assets/js/144.22f9176e.js index f6e144a9a..fd3fb8964 100644 --- a/docs/.vuepress/dist/assets/js/144.5dce0394.js +++ b/docs/.vuepress/dist/assets/js/144.22f9176e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{414:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomashex"}})]),t._v(" "),a("h2",{attrs:{id:"randomashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomashex","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsHex")]),t._v("(length?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a hex string filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a hex string with the specified (optional) length filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("32")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{417:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomashex"}})]),t._v(" "),a("h2",{attrs:{id:"randomashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomashex","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsHex")]),t._v("(length?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a hex string filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a hex string with the specified (optional) length filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("32")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/145.fe841153.js b/docs/.vuepress/dist/assets/js/145.5b4bc4d5.js similarity index 97% rename from docs/.vuepress/dist/assets/js/145.fe841153.js rename to docs/.vuepress/dist/assets/js/145.5b4bc4d5.js index 46562fa95..41f5a9e44 100644 --- a/docs/.vuepress/dist/assets/js/145.fe841153.js +++ b/docs/.vuepress/dist/assets/js/145.5b4bc4d5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{416:function(t,s,a){"use strict";a.r(s);var r=a(46),n=Object(r.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomasnumber"}})]),t._v(" "),a("h2",{attrs:{id:"randomasnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomasnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsNumber")]),t._v("(): "),a("code",[t._v("number")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asNumber.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asNumber.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a random number from random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a random number generated from the secure bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => ")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("number")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{416:function(t,s,a){"use strict";a.r(s);var r=a(46),n=Object(r.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomasnumber"}})]),t._v(" "),a("h2",{attrs:{id:"randomasnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomasnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsNumber")]),t._v("(): "),a("code",[t._v("number")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asNumber.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asNumber.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a random number from random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a random number generated from the secure bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => ")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("number")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/146.993fb79e.js b/docs/.vuepress/dist/assets/js/146.af7eed4e.js similarity index 96% rename from docs/.vuepress/dist/assets/js/146.993fb79e.js rename to docs/.vuepress/dist/assets/js/146.af7eed4e.js index 50e8f8440..662a9d4d8 100644 --- a/docs/.vuepress/dist/assets/js/146.993fb79e.js +++ b/docs/.vuepress/dist/assets/js/146.af7eed4e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{413:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"randomasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"randomasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#randomasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("randomAsU8a")]),t._v("(length?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": randomAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified (optional) length filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("32")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{414:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"randomasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"randomasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#randomasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("randomAsU8a")]),t._v("(length?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": randomAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified (optional) length filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("32")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/147.b50687bc.js b/docs/.vuepress/dist/assets/js/147.ee00a155.js similarity index 93% rename from docs/.vuepress/dist/assets/js/147.b50687bc.js rename to docs/.vuepress/dist/assets/js/147.ee00a155.js index 3ebfa3a7f..aff06259c 100644 --- a/docs/.vuepress/dist/assets/js/147.b50687bc.js +++ b/docs/.vuepress/dist/assets/js/147.ee00a155.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{411:function(e,r,t){"use strict";t.r(r);var o=t(46),s=Object(o.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelkeypairfromseed"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelkeypairfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelKeypairFromSeed")]),e._v("(seed: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/keypair/fromSeed.ts:16"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Returns a object containing a "),t("code",[e._v("publicKey")]),e._v(" & "),t("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("seed")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{413:function(e,r,t){"use strict";t.r(r);var o=t(46),s=Object(o.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelkeypairfromseed"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelkeypairfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelKeypairFromSeed")]),e._v("(seed: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/keypair/fromSeed.ts:16"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Returns a object containing a "),t("code",[e._v("publicKey")]),e._v(" & "),t("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("seed")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/148.7382f96a.js b/docs/.vuepress/dist/assets/js/148.9f987a2b.js similarity index 87% rename from docs/.vuepress/dist/assets/js/148.7382f96a.js rename to docs/.vuepress/dist/assets/js/148.9f987a2b.js index 7e0802090..25cdef7e3 100644 --- a/docs/.vuepress/dist/assets/js/148.7382f96a.js +++ b/docs/.vuepress/dist/assets/js/148.9f987a2b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{410:function(r,e,t){"use strict";t.r(e);var a=t(46),o=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[r._v("#")]),r._v(" Functions")]),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelisready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelisready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelisready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelIsReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelIsReady")]),r._v("(): "),t("code",[r._v("boolean")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/ready.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:11"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("boolean")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelwaitready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelwaitready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelwaitready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelWaitReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelWaitReady")]),r._v("(): "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/ready.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:7"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{411:function(r,e,t){"use strict";t.r(e);var a=t(46),o=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[r._v("#")]),r._v(" Functions")]),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelisready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelisready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelisready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelIsReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelIsReady")]),r._v("(): "),t("code",[r._v("boolean")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:11"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("boolean")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelwaitready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelwaitready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelwaitready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelWaitReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelWaitReady")]),r._v("(): "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:7"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/149.169f2da8.js b/docs/.vuepress/dist/assets/js/149.cad6b842.js similarity index 93% rename from docs/.vuepress/dist/assets/js/149.169f2da8.js rename to docs/.vuepress/dist/assets/js/149.cad6b842.js index 46b82cc27..4e5da1ac7 100644 --- a/docs/.vuepress/dist/assets/js/149.169f2da8.js +++ b/docs/.vuepress/dist/assets/js/149.cad6b842.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{408:function(e,t,r){"use strict";r.r(t);var s=r(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"schnorrkelsign"}})]),e._v(" "),r("h2",{attrs:{id:"schnorrkelsign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelsign","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelSign")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("schnorrkelSign")]),e._v("(message: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", __namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/sign.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/sign.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": schnorrkelSign")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns message signature of "),r("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("message")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{410:function(e,t,r){"use strict";r.r(t);var s=r(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"schnorrkelsign"}})]),e._v(" "),r("h2",{attrs:{id:"schnorrkelsign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelsign","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelSign")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("schnorrkelSign")]),e._v("(message: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", __namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/sign.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/sign.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": schnorrkelSign")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns message signature of "),r("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("message")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/15.ae11b970.js b/docs/.vuepress/dist/assets/js/15.06d67387.js similarity index 94% rename from docs/.vuepress/dist/assets/js/15.ae11b970.js rename to docs/.vuepress/dist/assets/js/15.06d67387.js index c9379ba8b..cf45926ce 100644 --- a/docs/.vuepress/dist/assets/js/15.ae11b970.js +++ b/docs/.vuepress/dist/assets/js/15.06d67387.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{400:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("FileTreeDb")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new FileTreeDb")]),e._v("(location: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("location")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"_location"}})]),e._v(" "),r("h2",{attrs:{id:"location"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#location","aria-hidden":"true"}},[e._v("#")]),e._v(" _location")]),e._v(" "),r("p",[r("strong",[e._v("● _location")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),e._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[e._v("#")]),e._v(" close")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("close")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[e._v("close")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),e._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[e._v("#")]),e._v(" del")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("del")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[e._v("del")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:76"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),e._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[e._v("#")]),e._v(" drop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("drop")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[e._v("drop")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),e._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[e._v("#")]),e._v(" empty")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("empty")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[e._v("empty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),e._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[e._v("#")]),e._v(" get")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("get")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[e._v("get")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:86"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),e._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[e._v("#")]),e._v(" maintain")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("maintain")]),e._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[e._v("maintain")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("fn")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),e._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[e._v("#")]),e._v(" open")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("open")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[e._v("open")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),e._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[e._v("#")]),e._v(" put")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("put")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[e._v("put")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:100"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),e._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[e._v("#")]),e._v(" rename")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("rename")]),e._v("(base: "),r("em",[r("code",[e._v("string")])]),e._v(", file: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[e._v("rename")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("base")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("file")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),e._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[e._v("#")]),e._v(" size")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("size")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[e._v("size")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{400:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("FileTreeDb")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new FileTreeDb")]),e._v("(location: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("location")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"_location"}})]),e._v(" "),r("h2",{attrs:{id:"location"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#location","aria-hidden":"true"}},[e._v("#")]),e._v(" _location")]),e._v(" "),r("p",[r("strong",[e._v("● _location")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),e._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[e._v("#")]),e._v(" close")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("close")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[e._v("close")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),e._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[e._v("#")]),e._v(" del")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("del")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[e._v("del")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:76"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),e._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[e._v("#")]),e._v(" drop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("drop")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[e._v("drop")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),e._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[e._v("#")]),e._v(" empty")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("empty")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[e._v("empty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),e._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[e._v("#")]),e._v(" get")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("get")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[e._v("get")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:86"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),e._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[e._v("#")]),e._v(" maintain")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("maintain")]),e._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[e._v("maintain")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("fn")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),e._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[e._v("#")]),e._v(" open")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("open")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[e._v("open")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),e._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[e._v("#")]),e._v(" put")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("put")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[e._v("put")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:100"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),e._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[e._v("#")]),e._v(" rename")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("rename")]),e._v("(base: "),r("em",[r("code",[e._v("string")])]),e._v(", file: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[e._v("rename")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("base")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("file")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),e._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[e._v("#")]),e._v(" size")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("size")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[e._v("size")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/151.ec8f8baf.js b/docs/.vuepress/dist/assets/js/151.07167f62.js similarity index 93% rename from docs/.vuepress/dist/assets/js/151.ec8f8baf.js rename to docs/.vuepress/dist/assets/js/151.07167f62.js index 703edcbb3..bd4c68015 100644 --- a/docs/.vuepress/dist/assets/js/151.ec8f8baf.js +++ b/docs/.vuepress/dist/assets/js/151.07167f62.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[151],{405:function(e,r,t){"use strict";t.r(r);var n=t(46),s=Object(n.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelverify"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelverify"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelverify","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelVerify")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelVerify")]),e._v("(message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", publicKey: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("code",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/verify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/verify.ts:11"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelVerify")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Verifies the signature of "),t("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("publicKey")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("boolean")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[151],{408:function(e,r,t){"use strict";t.r(r);var n=t(46),s=Object(n.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelverify"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelverify"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelverify","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelVerify")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelVerify")]),e._v("(message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", publicKey: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("code",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/verify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/verify.ts:11"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelVerify")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Verifies the signature of "),t("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("publicKey")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("boolean")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/152.5bf4a9d1.js b/docs/.vuepress/dist/assets/js/152.45295d3e.js similarity index 93% rename from docs/.vuepress/dist/assets/js/152.5bf4a9d1.js rename to docs/.vuepress/dist/assets/js/152.45295d3e.js index a2f74850a..578863a0b 100644 --- a/docs/.vuepress/dist/assets/js/152.5bf4a9d1.js +++ b/docs/.vuepress/dist/assets/js/152.45295d3e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{404:function(e,r,t){"use strict";t.r(r);var v=t(46),s=Object(v.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"secp256k1recover"}})]),e._v(" "),t("h2",{attrs:{id:"secp256k1recover"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#secp256k1recover","aria-hidden":"true"}},[e._v("#")]),e._v(" secp256k1Recover")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("secp256k1Recover")]),e._v("(_message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", _signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", recovery: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/secp256k1/recover.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("secp256k1/recover.ts:12"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": secp256k1Recover")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Recovers a publicKey from the supplied signature")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("_message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("_signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("recovery")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{405:function(e,r,t){"use strict";t.r(r);var v=t(46),s=Object(v.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"secp256k1recover"}})]),e._v(" "),t("h2",{attrs:{id:"secp256k1recover"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#secp256k1recover","aria-hidden":"true"}},[e._v("#")]),e._v(" secp256k1Recover")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("secp256k1Recover")]),e._v("(_message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", _signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", recovery: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/secp256k1/recover.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("secp256k1/recover.ts:12"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": secp256k1Recover")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Recovers a publicKey from the supplied signature")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("_message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("_signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("recovery")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/153.6fd22459.js b/docs/.vuepress/dist/assets/js/153.b09d25ec.js similarity index 96% rename from docs/.vuepress/dist/assets/js/153.6fd22459.js rename to docs/.vuepress/dist/assets/js/153.b09d25ec.js index 6f6ba4f52..93ef45026 100644 --- a/docs/.vuepress/dist/assets/js/153.6fd22459.js +++ b/docs/.vuepress/dist/assets/js/153.b09d25ec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{402:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"sha512asu8a"}})]),t._v(" "),s("h2",{attrs:{id:"sha512asu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sha512asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" sha512AsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("sha512AsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/sha512/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("sha512/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": sha512AsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates sha-512 hash of the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a sha-512 "),s("code",[t._v("Uint8Array")]),t._v(" from the supplied data.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" sha512AsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sha512AsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Uint8Array"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{404:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"sha512asu8a"}})]),t._v(" "),s("h2",{attrs:{id:"sha512asu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sha512asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" sha512AsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("sha512AsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/sha512/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("sha512/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": sha512AsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates sha-512 hash of the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a sha-512 "),s("code",[t._v("Uint8Array")]),t._v(" from the supplied data.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" sha512AsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sha512AsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Uint8Array"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/154.1d97d73b.js b/docs/.vuepress/dist/assets/js/154.dcf40e55.js similarity index 89% rename from docs/.vuepress/dist/assets/js/154.1d97d73b.js rename to docs/.vuepress/dist/assets/js/154.dcf40e55.js index 4df3da197..5e61f3e09 100644 --- a/docs/.vuepress/dist/assets/js/154.1d97d73b.js +++ b/docs/.vuepress/dist/assets/js/154.dcf40e55.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[154],{401:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"keypairtype"}})]),t._v(" "),a("h2",{attrs:{id:"keypairtype"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keypairtype","aria-hidden":"true"}},[t._v("#")]),t._v(" KeypairType")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ KeypairType")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[154],{402:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"keypairtype"}})]),t._v(" "),a("h2",{attrs:{id:"keypairtype"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keypairtype","aria-hidden":"true"}},[t._v("#")]),t._v(" KeypairType")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ KeypairType")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/155.86d3e248.js b/docs/.vuepress/dist/assets/js/155.e8630fed.js similarity index 96% rename from docs/.vuepress/dist/assets/js/155.86d3e248.js rename to docs/.vuepress/dist/assets/js/155.e8630fed.js index 9789a0368..8d7e79e41 100644 --- a/docs/.vuepress/dist/assets/js/155.86d3e248.js +++ b/docs/.vuepress/dist/assets/js/155.e8630fed.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[155],{399:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashashex"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashashex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsHex")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asHex.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a hex string with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[155],{401:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashashex"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashashex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsHex")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asHex.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a hex string with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/156.3ff57cbd.js b/docs/.vuepress/dist/assets/js/156.cd310ab3.js similarity index 96% rename from docs/.vuepress/dist/assets/js/156.3ff57cbd.js rename to docs/.vuepress/dist/assets/js/156.cd310ab3.js index 22cb8ab50..2293f9ca9 100644 --- a/docs/.vuepress/dist/assets/js/156.3ff57cbd.js +++ b/docs/.vuepress/dist/assets/js/156.cd310ab3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{398:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 u8a from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{399:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 u8a from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/157.e789498f.js b/docs/.vuepress/dist/assets/js/157.fbb601cd.js similarity index 96% rename from docs/.vuepress/dist/assets/js/157.e789498f.js rename to docs/.vuepress/dist/assets/js/157.fbb601cd.js index 8754c345e..581e9681c 100644 --- a/docs/.vuepress/dist/assets/js/157.e789498f.js +++ b/docs/.vuepress/dist/assets/js/157.fbb601cd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{396:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64asbn"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64asbn"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asbn","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsBn")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsBn")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("BN")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asBn.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsBn")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash BN from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a BN.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsBn")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => new BN(0xe29f70f8b8c96df7)")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("BN")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{398:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64asbn"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64asbn"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asbn","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsBn")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsBn")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("BN")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asBn.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsBn")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash BN from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a BN.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsBn")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => new BN(0xe29f70f8b8c96df7)")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("BN")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/158.0c8adac7.js b/docs/.vuepress/dist/assets/js/158.2d59a307.js similarity index 98% rename from docs/.vuepress/dist/assets/js/158.0c8adac7.js rename to docs/.vuepress/dist/assets/js/158.2d59a307.js index 43bcf02c1..c94cb8609 100644 --- a/docs/.vuepress/dist/assets/js/158.0c8adac7.js +++ b/docs/.vuepress/dist/assets/js/158.2d59a307.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{395:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64ashex"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{395:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64ashex"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/159.2cd39198.js b/docs/.vuepress/dist/assets/js/159.c5393dcf.js similarity index 96% rename from docs/.vuepress/dist/assets/js/159.2cd39198.js rename to docs/.vuepress/dist/assets/js/159.c5393dcf.js index 3f99f1414..a0ec2c52f 100644 --- a/docs/.vuepress/dist/assets/js/159.2cd39198.js +++ b/docs/.vuepress/dist/assets/js/159.c5393dcf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{393:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asraw"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asraw"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asraw","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsRaw")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsRaw")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asRaw.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsRaw")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash non-prefixed hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a non-prefixed hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsRaw "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsRaw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{396:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asraw"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asraw"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asraw","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsRaw")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsRaw")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asRaw.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsRaw")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash non-prefixed hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a non-prefixed hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsRaw "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsRaw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/16.95bbe85f.js b/docs/.vuepress/dist/assets/js/16.f65ce986.js similarity index 94% rename from docs/.vuepress/dist/assets/js/16.95bbe85f.js rename to docs/.vuepress/dist/assets/js/16.f65ce986.js index 204564a69..ce3534f83 100644 --- a/docs/.vuepress/dist/assets/js/16.95bbe85f.js +++ b/docs/.vuepress/dist/assets/js/16.f65ce986.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{403:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("LruDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new LruDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(", itemCount?: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" itemCount")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("DEFAULT_ITEM_COUNT")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"_getlru"}})]),t._v(" "),r("h2",{attrs:{id:"getlru"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getlru","aria-hidden":"true"}},[t._v("#")]),t._v(" _getLru")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("_getLru")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:91"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{403:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("LruDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new LruDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(", itemCount?: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" itemCount")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("DEFAULT_ITEM_COUNT")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"_getlru"}})]),t._v(" "),r("h2",{attrs:{id:"getlru"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getlru","aria-hidden":"true"}},[t._v("#")]),t._v(" _getLru")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("_getLru")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:91"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/160.8c2a737a.js b/docs/.vuepress/dist/assets/js/160.9d78b704.js similarity index 96% rename from docs/.vuepress/dist/assets/js/160.8c2a737a.js rename to docs/.vuepress/dist/assets/js/160.9d78b704.js index 696d73b6e..e3a0119f6 100644 --- a/docs/.vuepress/dist/assets/js/160.8c2a737a.js +++ b/docs/.vuepress/dist/assets/js/160.9d78b704.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{392:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asvalue"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsValue")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asValue.ts:22"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsValue")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex number from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex number")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsValue "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{393:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asvalue"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsValue")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asValue.ts:22"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsValue")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex number from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex number")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsValue "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/161.64ced865.js b/docs/.vuepress/dist/assets/js/161.7cf36eee.js similarity index 97% rename from docs/.vuepress/dist/assets/js/161.64ced865.js rename to docs/.vuepress/dist/assets/js/161.7cf36eee.js index e4444ce90..eafe3eb0b 100644 --- a/docs/.vuepress/dist/assets/js/161.64ced865.js +++ b/docs/.vuepress/dist/assets/js/161.7cf36eee.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[161],{390:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-util-rlp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util-rlp","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util-rlp")]),t._v(" "),a("p",[t._v("Utility methods for encoding and decoding "),a("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/%5BEnglish%5D-RLP",target:"_blank",rel:"noopener noreferrer"}},[t._v("Ethereum RLP structures"),a("OutboundLink")],1),t._v(". This is port adapted from the original "),a("a",{attrs:{href:"https://github.com/ethereumjs/rlp/blob/0ce09db81fc303fcee593f7cc094ba44015f9b92/index.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("EthereumJS RLP"),a("OutboundLink")],1),t._v(" implementation to cater for "),a("code",[t._v("Uint8Array")]),t._v(" outputs (instead of "),a("code",[t._v("Buffer")]),t._v(") in addition to typings.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/util-rlp\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Functions can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" decode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" encode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/util-rlp/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[161],{392:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-util-rlp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util-rlp","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util-rlp")]),t._v(" "),a("p",[t._v("Utility methods for encoding and decoding "),a("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/%5BEnglish%5D-RLP",target:"_blank",rel:"noopener noreferrer"}},[t._v("Ethereum RLP structures"),a("OutboundLink")],1),t._v(". This is port adapted from the original "),a("a",{attrs:{href:"https://github.com/ethereumjs/rlp/blob/0ce09db81fc303fcee593f7cc094ba44015f9b92/index.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("EthereumJS RLP"),a("OutboundLink")],1),t._v(" implementation to cater for "),a("code",[t._v("Uint8Array")]),t._v(" outputs (instead of "),a("code",[t._v("Buffer")]),t._v(") in addition to typings.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/util-rlp\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Functions can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" decode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" encode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/util-rlp/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/162.dc3e872c.js b/docs/.vuepress/dist/assets/js/162.44f64348.js similarity index 96% rename from docs/.vuepress/dist/assets/js/162.dc3e872c.js rename to docs/.vuepress/dist/assets/js/162.44f64348.js index 11c90103a..5802398af 100644 --- a/docs/.vuepress/dist/assets/js/162.dc3e872c.js +++ b/docs/.vuepress/dist/assets/js/162.44f64348.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{389:function(t,e,l){"use strict";l.r(e);var r=l(46),o=Object(r.a)({},function(){var t=this,e=t.$createElement,l=t._self._c||e;return l("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[l("ul",[l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decode_.html"}},[t._v('"decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_decode_.html"}},[t._v('"decoder/decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listlong_.html"}},[t._v('"decoder/listLong"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listshort_.html"}},[t._v('"decoder/listShort"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_number_.html"}},[t._v('"decoder/number"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_safeparseint_.html"}},[t._v('"decoder/safeParseInt"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_single_.html"}},[t._v('"decoder/single"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_string_.html"}},[t._v('"decoder/string"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html"}},[t._v('"decoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encode_.html"}},[t._v('"encode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_array_.html"}},[t._v('"encoder/array"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_length_.html"}},[t._v('"encoder/length"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_tou8a_.html"}},[t._v('"encoder/toU8a"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html"}},[t._v('"encoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_u8a_.html"}},[t._v('"encoder/u8a"')])],1)])])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{390:function(t,e,l){"use strict";l.r(e);var r=l(46),o=Object(r.a)({},function(){var t=this,e=t.$createElement,l=t._self._c||e;return l("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[l("ul",[l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decode_.html"}},[t._v('"decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_decode_.html"}},[t._v('"decoder/decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listlong_.html"}},[t._v('"decoder/listLong"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listshort_.html"}},[t._v('"decoder/listShort"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_number_.html"}},[t._v('"decoder/number"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_safeparseint_.html"}},[t._v('"decoder/safeParseInt"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_single_.html"}},[t._v('"decoder/single"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_string_.html"}},[t._v('"decoder/string"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html"}},[t._v('"decoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encode_.html"}},[t._v('"encode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_array_.html"}},[t._v('"encoder/array"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_length_.html"}},[t._v('"encoder/length"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_tou8a_.html"}},[t._v('"encoder/toU8a"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html"}},[t._v('"encoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_u8a_.html"}},[t._v('"encoder/u8a"')])],1)])])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/163.60ed198b.js b/docs/.vuepress/dist/assets/js/163.6d8d5318.js similarity index 79% rename from docs/.vuepress/dist/assets/js/163.60ed198b.js rename to docs/.vuepress/dist/assets/js/163.6d8d5318.js index 786168072..a89ccbdac 100644 --- a/docs/.vuepress/dist/assets/js/163.60ed198b.js +++ b/docs/.vuepress/dist/assets/js/163.6d8d5318.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{386:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{387:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/164.e2ee7199.js b/docs/.vuepress/dist/assets/js/164.5c07ac11.js similarity index 88% rename from docs/.vuepress/dist/assets/js/164.e2ee7199.js rename to docs/.vuepress/dist/assets/js/164.5c07ac11.js index 665d95f27..ebb715862 100644 --- a/docs/.vuepress/dist/assets/js/164.e2ee7199.js +++ b/docs/.vuepress/dist/assets/js/164.5c07ac11.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{387:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),t._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[t._v("#")]),t._v(" decode")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decode")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/decode.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/decode.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{389:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),t._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[t._v("#")]),t._v(" decode")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decode")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/decode.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/decode.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/165.7e016509.js b/docs/.vuepress/dist/assets/js/165.3ea85802.js similarity index 93% rename from docs/.vuepress/dist/assets/js/165.7e016509.js rename to docs/.vuepress/dist/assets/js/165.3ea85802.js index 021912194..052b4ad32 100644 --- a/docs/.vuepress/dist/assets/js/165.7e016509.js +++ b/docs/.vuepress/dist/assets/js/165.3ea85802.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{384:function(t,e,o){"use strict";o.r(e);var r=o(46),d=Object(r.a)({},function(){var t=this,e=t.$createElement,o=t._self._c||e;return o("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),o("p",[o("a",{attrs:{id:"decodelistlong"}})]),t._v(" "),o("h2",{attrs:{id:"decodelistlong"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodelistlong","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListLong")]),t._v(" "),o("p",[t._v("▸ "),o("strong",[t._v("decodeListLong")]),t._v("(decode: "),o("em",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),o("em",[o("code",[t._v("Uint8Array")])]),t._v("): "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("p",[o("em",[t._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/listLong.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listLong.ts:11"),o("OutboundLink")],1)])]),t._v(" "),o("p",[o("strong",[t._v("Parameters:")])]),t._v(" "),o("table",[o("thead",[o("tr",[o("th",[t._v("Name")]),t._v(" "),o("th",[t._v("Type")])])]),t._v(" "),o("tbody",[o("tr",[o("td",[t._v("decode")]),t._v(" "),o("td",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),o("tr",[o("td",[t._v("input")]),t._v(" "),o("td",[o("code",[t._v("Uint8Array")])])])])]),t._v(" "),o("p",[o("strong",[t._v("Returns:")]),t._v(" "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{386:function(t,e,o){"use strict";o.r(e);var r=o(46),d=Object(r.a)({},function(){var t=this,e=t.$createElement,o=t._self._c||e;return o("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),o("p",[o("a",{attrs:{id:"decodelistlong"}})]),t._v(" "),o("h2",{attrs:{id:"decodelistlong"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodelistlong","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListLong")]),t._v(" "),o("p",[t._v("▸ "),o("strong",[t._v("decodeListLong")]),t._v("(decode: "),o("em",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),o("em",[o("code",[t._v("Uint8Array")])]),t._v("): "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("p",[o("em",[t._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listLong.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listLong.ts:11"),o("OutboundLink")],1)])]),t._v(" "),o("p",[o("strong",[t._v("Parameters:")])]),t._v(" "),o("table",[o("thead",[o("tr",[o("th",[t._v("Name")]),t._v(" "),o("th",[t._v("Type")])])]),t._v(" "),o("tbody",[o("tr",[o("td",[t._v("decode")]),t._v(" "),o("td",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),o("tr",[o("td",[t._v("input")]),t._v(" "),o("td",[o("code",[t._v("Uint8Array")])])])])]),t._v(" "),o("p",[o("strong",[t._v("Returns:")]),t._v(" "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/166.b0737c5f.js b/docs/.vuepress/dist/assets/js/166.e8c681e5.js similarity index 93% rename from docs/.vuepress/dist/assets/js/166.b0737c5f.js rename to docs/.vuepress/dist/assets/js/166.e8c681e5.js index 448f181f2..b6003672c 100644 --- a/docs/.vuepress/dist/assets/js/166.b0737c5f.js +++ b/docs/.vuepress/dist/assets/js/166.e8c681e5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{383:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodelistshort"}})]),t._v(" "),r("h2",{attrs:{id:"decodelistshort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodelistshort","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListShort")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeListShort")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/listShort.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listShort.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{384:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodelistshort"}})]),t._v(" "),r("h2",{attrs:{id:"decodelistshort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodelistshort","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListShort")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeListShort")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listShort.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listShort.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/167.858fb2ba.js b/docs/.vuepress/dist/assets/js/167.ba95f807.js similarity index 93% rename from docs/.vuepress/dist/assets/js/167.858fb2ba.js rename to docs/.vuepress/dist/assets/js/167.ba95f807.js index b8a21f707..d03415bff 100644 --- a/docs/.vuepress/dist/assets/js/167.858fb2ba.js +++ b/docs/.vuepress/dist/assets/js/167.ba95f807.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{381:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodenumber"}})]),e._v(" "),r("h2",{attrs:{id:"decodenumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenumber","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNumber")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/number.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/number.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{383:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodenumber"}})]),e._v(" "),r("h2",{attrs:{id:"decodenumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenumber","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNumber")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/number.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/number.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/168.16411a15.js b/docs/.vuepress/dist/assets/js/168.99af1574.js similarity index 91% rename from docs/.vuepress/dist/assets/js/168.16411a15.js rename to docs/.vuepress/dist/assets/js/168.99af1574.js index 820b3d620..86652d0f5 100644 --- a/docs/.vuepress/dist/assets/js/168.16411a15.js +++ b/docs/.vuepress/dist/assets/js/168.99af1574.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{380:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"safeparseint"}})]),t._v(" "),r("h2",{attrs:{id:"safeparseint"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#safeparseint","aria-hidden":"true"}},[t._v("#")]),t._v(" safeParseInt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("safeParseInt")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/safeParseInt.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/safeParseInt.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{381:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"safeparseint"}})]),t._v(" "),r("h2",{attrs:{id:"safeparseint"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#safeparseint","aria-hidden":"true"}},[t._v("#")]),t._v(" safeParseInt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("safeParseInt")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/safeParseInt.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/safeParseInt.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/169.a29d3d45.js b/docs/.vuepress/dist/assets/js/169.3a3e8489.js similarity index 93% rename from docs/.vuepress/dist/assets/js/169.a29d3d45.js rename to docs/.vuepress/dist/assets/js/169.3a3e8489.js index 5f4a1a8f6..85ee72f5c 100644 --- a/docs/.vuepress/dist/assets/js/169.a29d3d45.js +++ b/docs/.vuepress/dist/assets/js/169.3a3e8489.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{378:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodesingle"}})]),e._v(" "),r("h2",{attrs:{id:"decodesingle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodesingle","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeSingle")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeSingle")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/single.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/single.ts:7"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{380:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodesingle"}})]),e._v(" "),r("h2",{attrs:{id:"decodesingle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodesingle","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeSingle")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeSingle")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/single.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/single.ts:7"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/17.fd584dac.js b/docs/.vuepress/dist/assets/js/17.66687909.js similarity index 94% rename from docs/.vuepress/dist/assets/js/17.fd584dac.js rename to docs/.vuepress/dist/assets/js/17.66687909.js index eab17cb73..e0afa7118 100644 --- a/docs/.vuepress/dist/assets/js/17.fd584dac.js +++ b/docs/.vuepress/dist/assets/js/17.66687909.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{406:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("MemoryDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MemoryDb")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:62"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{409:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("MemoryDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MemoryDb")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:62"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/170.6f387bfc.js b/docs/.vuepress/dist/assets/js/170.50e773a0.js similarity index 93% rename from docs/.vuepress/dist/assets/js/170.6f387bfc.js rename to docs/.vuepress/dist/assets/js/170.50e773a0.js index d9b025440..16a36034f 100644 --- a/docs/.vuepress/dist/assets/js/170.6f387bfc.js +++ b/docs/.vuepress/dist/assets/js/170.50e773a0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{377:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodestring"}})]),t._v(" "),r("h2",{attrs:{id:"decodestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodestring","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeString")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/string.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/string.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{378:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodestring"}})]),t._v(" "),r("h2",{attrs:{id:"decodestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodestring","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeString")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/string.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/string.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/171.149c0894.js b/docs/.vuepress/dist/assets/js/171.2c1f7987.js similarity index 92% rename from docs/.vuepress/dist/assets/js/171.149c0894.js rename to docs/.vuepress/dist/assets/js/171.2c1f7987.js index bc57585c5..0a2d40a21 100644 --- a/docs/.vuepress/dist/assets/js/171.149c0894.js +++ b/docs/.vuepress/dist/assets/js/171.2c1f7987.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{375:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodefunc"}})]),t._v(" "),r("h2",{attrs:{id:"decodefunc"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeFunc")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeFunc")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeoutput"}})]),t._v(" "),r("h2",{attrs:{id:"decodeoutput"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeoutput","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeOutput")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeOutput")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{377:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodefunc"}})]),t._v(" "),r("h2",{attrs:{id:"decodefunc"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeFunc")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeFunc")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeoutput"}})]),t._v(" "),r("h2",{attrs:{id:"decodeoutput"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeoutput","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeOutput")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeOutput")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/172.d5bc02b3.js b/docs/.vuepress/dist/assets/js/172.d6fe72c8.js similarity index 79% rename from docs/.vuepress/dist/assets/js/172.d5bc02b3.js rename to docs/.vuepress/dist/assets/js/172.d6fe72c8.js index ae8fba8d3..2fff5e35f 100644 --- a/docs/.vuepress/dist/assets/js/172.d5bc02b3.js +++ b/docs/.vuepress/dist/assets/js/172.d6fe72c8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{374:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{375:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/173.9731762d.js b/docs/.vuepress/dist/assets/js/173.fa8116ca.js similarity index 92% rename from docs/.vuepress/dist/assets/js/173.9731762d.js rename to docs/.vuepress/dist/assets/js/173.fa8116ca.js index f556277f6..73273040e 100644 --- a/docs/.vuepress/dist/assets/js/173.9731762d.js +++ b/docs/.vuepress/dist/assets/js/173.fa8116ca.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[173],{372:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodearray"}})]),t._v(" "),r("h2",{attrs:{id:"encodearray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodearray","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeArray")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/array.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/array.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[173],{374:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodearray"}})]),t._v(" "),r("h2",{attrs:{id:"encodearray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodearray","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeArray")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/array.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/array.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/174.d16257f1.js b/docs/.vuepress/dist/assets/js/174.cd35051f.js similarity index 92% rename from docs/.vuepress/dist/assets/js/174.d16257f1.js rename to docs/.vuepress/dist/assets/js/174.cd35051f.js index 9d1e36c16..cc4b83731 100644 --- a/docs/.vuepress/dist/assets/js/174.d16257f1.js +++ b/docs/.vuepress/dist/assets/js/174.cd35051f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{371:function(e,t,n){"use strict";n.r(t);var r=n(46),o=Object(r.a)({},function(){var e=this,t=e.$createElement,n=e._self._c||t;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),n("p",[n("a",{attrs:{id:"encodelength"}})]),e._v(" "),n("h2",{attrs:{id:"encodelength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#encodelength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeLength")]),e._v(" "),n("p",[e._v("▸ "),n("strong",[e._v("encodeLength")]),e._v("(length: "),n("em",[n("code",[e._v("number")])]),e._v(", offset: "),n("em",[n("code",[e._v("number")])]),e._v("): "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("p",[n("em",[e._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/length.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("encoder/length.ts:7"),n("OutboundLink")],1)])]),e._v(" "),n("p",[n("strong",[e._v("Parameters:")])]),e._v(" "),n("table",[n("thead",[n("tr",[n("th",[e._v("Name")]),e._v(" "),n("th",[e._v("Type")])])]),e._v(" "),n("tbody",[n("tr",[n("td",[e._v("length")]),e._v(" "),n("td",[n("code",[e._v("number")])])]),e._v(" "),n("tr",[n("td",[e._v("offset")]),e._v(" "),n("td",[n("code",[e._v("number")])])])])]),e._v(" "),n("p",[n("strong",[e._v("Returns:")]),e._v(" "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{372:function(e,t,n){"use strict";n.r(t);var r=n(46),o=Object(r.a)({},function(){var e=this,t=e.$createElement,n=e._self._c||t;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),n("p",[n("a",{attrs:{id:"encodelength"}})]),e._v(" "),n("h2",{attrs:{id:"encodelength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#encodelength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeLength")]),e._v(" "),n("p",[e._v("▸ "),n("strong",[e._v("encodeLength")]),e._v("(length: "),n("em",[n("code",[e._v("number")])]),e._v(", offset: "),n("em",[n("code",[e._v("number")])]),e._v("): "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("p",[n("em",[e._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/length.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("encoder/length.ts:7"),n("OutboundLink")],1)])]),e._v(" "),n("p",[n("strong",[e._v("Parameters:")])]),e._v(" "),n("table",[n("thead",[n("tr",[n("th",[e._v("Name")]),e._v(" "),n("th",[e._v("Type")])])]),e._v(" "),n("tbody",[n("tr",[n("td",[e._v("length")]),e._v(" "),n("td",[n("code",[e._v("number")])])]),e._v(" "),n("tr",[n("td",[e._v("offset")]),e._v(" "),n("td",[n("code",[e._v("number")])])])])]),e._v(" "),n("p",[n("strong",[e._v("Returns:")]),e._v(" "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/175.c7cc1cc6.js b/docs/.vuepress/dist/assets/js/175.d225e122.js similarity index 95% rename from docs/.vuepress/dist/assets/js/175.c7cc1cc6.js rename to docs/.vuepress/dist/assets/js/175.d225e122.js index 5747e5798..698fa8dea 100644 --- a/docs/.vuepress/dist/assets/js/175.c7cc1cc6.js +++ b/docs/.vuepress/dist/assets/js/175.d225e122.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[175],{370:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tou8a"}})]),t._v(" "),a("h2",{attrs:{id:"tou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/toU8a.ts:39"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[175],{370:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tou8a"}})]),t._v(" "),a("h2",{attrs:{id:"tou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/toU8a.ts:39"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/176.18060492.js b/docs/.vuepress/dist/assets/js/176.037c9c6a.js similarity index 92% rename from docs/.vuepress/dist/assets/js/176.18060492.js rename to docs/.vuepress/dist/assets/js/176.037c9c6a.js index dfa7eeac4..f677be6b8 100644 --- a/docs/.vuepress/dist/assets/js/176.18060492.js +++ b/docs/.vuepress/dist/assets/js/176.037c9c6a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{369:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"encodefunc"}})]),t._v(" "),a("h2",{attrs:{id:"encodefunc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#encodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" EncodeFunc")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ EncodeFunc")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(input: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{371:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"encodefunc"}})]),t._v(" "),a("h2",{attrs:{id:"encodefunc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#encodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" EncodeFunc")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ EncodeFunc")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(input: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/177.7c4e5a2a.js b/docs/.vuepress/dist/assets/js/177.25bdd03b.js similarity index 92% rename from docs/.vuepress/dist/assets/js/177.7c4e5a2a.js rename to docs/.vuepress/dist/assets/js/177.25bdd03b.js index e052d2d04..f7f946a43 100644 --- a/docs/.vuepress/dist/assets/js/177.7c4e5a2a.js +++ b/docs/.vuepress/dist/assets/js/177.25bdd03b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{368:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"encodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeU8a")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/u8a.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/u8a.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{369:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"encodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeU8a")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/u8a.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/u8a.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/178.31277632.js b/docs/.vuepress/dist/assets/js/178.15534701.js similarity index 97% rename from docs/.vuepress/dist/assets/js/178.31277632.js rename to docs/.vuepress/dist/assets/js/178.15534701.js index 129cd1358..2533645b6 100644 --- a/docs/.vuepress/dist/assets/js/178.31277632.js +++ b/docs/.vuepress/dist/assets/js/178.15534701.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{366:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-util"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util")]),t._v(" "),s("p",[t._v("Various useful utility functions that are used across all projects in the "),s("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("@polkadot"),s("OutboundLink")],1),t._v(" namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.")]),t._v(" "),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),s("p",[t._v("Installation -")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("yarn add @polkadot/util\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("p",[t._v("Functions can be imported directly from the package, e.g.")]),t._v(" "),s("div",{staticClass:"language-js line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("h2",{attrs:{id:"utilities"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),s("p",[s("router-link",{attrs:{to:"/util/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{368:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-util"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util")]),t._v(" "),s("p",[t._v("Various useful utility functions that are used across all projects in the "),s("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("@polkadot"),s("OutboundLink")],1),t._v(" namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.")]),t._v(" "),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),s("p",[t._v("Installation -")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("yarn add @polkadot/util\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("p",[t._v("Functions can be imported directly from the package, e.g.")]),t._v(" "),s("div",{staticClass:"language-js line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("h2",{attrs:{id:"utilities"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),s("p",[s("router-link",{attrs:{to:"/util/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/18.f5f8a4af.js b/docs/.vuepress/dist/assets/js/18.d8e7daec.js similarity index 93% rename from docs/.vuepress/dist/assets/js/18.f5f8a4af.js rename to docs/.vuepress/dist/assets/js/18.d8e7daec.js index a680c79ee..94ec34fb7 100644 --- a/docs/.vuepress/dist/assets/js/18.f5f8a4af.js +++ b/docs/.vuepress/dist/assets/js/18.d8e7daec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{409:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("TransactionDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new TransactionDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{406:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("TransactionDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new TransactionDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/180.6bab82f8.js b/docs/.vuepress/dist/assets/js/180.d0d7416a.js similarity index 91% rename from docs/.vuepress/dist/assets/js/180.6bab82f8.js rename to docs/.vuepress/dist/assets/js/180.d0d7416a.js index 645b5cf32..147522875 100644 --- a/docs/.vuepress/dist/assets/js/180.6bab82f8.js +++ b/docs/.vuepress/dist/assets/js/180.d0d7416a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{365:function(t,r,e){"use strict";e.r(r);var a=e(46),s=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": ExtError")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Extension to the basic JS Error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal "),e("code",[t._v("stack")]),t._v(", "),e("code",[t._v("message")]),t._v(", the numeric "),e("code",[t._v("code")]),t._v(" and "),e("code",[t._v("data")]),t._v(" (any types) parameters are available on the object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ExtError "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("throw")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ExtError")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some message'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ExtError"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CODES")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("METHOD_NOT_FOUND")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => error.code = -32601")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("code",[t._v("Error")])]),t._v(" "),e("p",[e("strong",[t._v("↳ ExtError")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1)]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new ExtError")]),t._v("(message?: "),e("em",[e("code",[t._v("string")])]),t._v(", code?: "),e("em",[e("code",[t._v("number")])]),t._v(", data?: "),e("em",[e("code",[t._v("any")])]),t._v("): "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" message")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v('""')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("UNKNOWN")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),e("td",[e("code",[t._v("any")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"code"}})]),t._v(" "),e("h2",{attrs:{id:"code"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),e("p",[e("strong",[t._v("● code")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#code"}},[t._v("code")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:35"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"data"}})]),t._v(" "),e("h2",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[e("strong",[t._v("● data")]),t._v(": "),e("em",[e("code",[t._v("any")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#data"}},[t._v("data")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:37"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"message"}})]),t._v(" "),e("h2",{attrs:{id:"message"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),e("p",[e("strong",[t._v("● message")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#message"}},[t._v("message")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.message")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:39"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"name"}})]),t._v(" "),e("h2",{attrs:{id:"name"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),e("p",[e("strong",[t._v("● name")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.name")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:41"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"stack"}})]),t._v(" "),e("h2",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[e("strong",[t._v("● stack")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#stack"}},[t._v("stack")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.stack")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"error"}})]),t._v(" "),e("h2",{attrs:{id:"static-error"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-error","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" Error")]),t._v(" "),e("p",[e("strong",[t._v("● Error")]),t._v(": "),e("em",[e("code",[t._v("ErrorConstructor")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984")])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"object-literals"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#object-literals","aria-hidden":"true"}},[t._v("#")]),t._v(" Object literals")]),t._v(" "),e("p",[e("a",{attrs:{id:"codes"}})]),t._v(" "),e("h2",{attrs:{id:"static-codes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-codes","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" CODES")]),t._v(" "),e("p",[e("strong",[t._v("CODES")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:60"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("a",{attrs:{id:"codes.assert"}})]),t._v(" "),e("h3",{attrs:{id:"assert"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" ASSERT")]),t._v(" "),e("p",[e("strong",[t._v("● ASSERT")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -90009")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:61"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.invalid_jsonrpc"}})]),t._v(" "),e("h3",{attrs:{id:"invalid-jsonrpc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#invalid-jsonrpc","aria-hidden":"true"}},[t._v("#")]),t._v(" INVALID_JSONRPC")]),t._v(" "),e("p",[e("strong",[t._v("● INVALID_JSONRPC")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -99998")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:63"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.method_not_found"}})]),t._v(" "),e("h3",{attrs:{id:"method-not-found"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#method-not-found","aria-hidden":"true"}},[t._v("#")]),t._v(" METHOD_NOT_FOUND")]),t._v(" "),e("p",[e("strong",[t._v("● METHOD_NOT_FOUND")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -32601")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:64"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.unknown"}})]),t._v(" "),e("h3",{attrs:{id:"unknown"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unknown","aria-hidden":"true"}},[t._v("#")]),t._v(" UNKNOWN")]),t._v(" "),e("p",[e("strong",[t._v("● UNKNOWN")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:62"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{362:function(t,r,e){"use strict";e.r(r);var a=e(46),s=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": ExtError")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Extension to the basic JS Error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal "),e("code",[t._v("stack")]),t._v(", "),e("code",[t._v("message")]),t._v(", the numeric "),e("code",[t._v("code")]),t._v(" and "),e("code",[t._v("data")]),t._v(" (any types) parameters are available on the object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ExtError "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("throw")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ExtError")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some message'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ExtError"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CODES")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("METHOD_NOT_FOUND")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => error.code = -32601")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("code",[t._v("Error")])]),t._v(" "),e("p",[e("strong",[t._v("↳ ExtError")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1)]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new ExtError")]),t._v("(message?: "),e("em",[e("code",[t._v("string")])]),t._v(", code?: "),e("em",[e("code",[t._v("number")])]),t._v(", data?: "),e("em",[e("code",[t._v("any")])]),t._v("): "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" message")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v('""')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("UNKNOWN")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),e("td",[e("code",[t._v("any")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"code"}})]),t._v(" "),e("h2",{attrs:{id:"code"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),e("p",[e("strong",[t._v("● code")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#code"}},[t._v("code")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:35"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"data"}})]),t._v(" "),e("h2",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[e("strong",[t._v("● data")]),t._v(": "),e("em",[e("code",[t._v("any")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#data"}},[t._v("data")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:37"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"message"}})]),t._v(" "),e("h2",{attrs:{id:"message"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),e("p",[e("strong",[t._v("● message")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#message"}},[t._v("message")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.message")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:39"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"name"}})]),t._v(" "),e("h2",{attrs:{id:"name"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),e("p",[e("strong",[t._v("● name")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.name")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:41"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"stack"}})]),t._v(" "),e("h2",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[e("strong",[t._v("● stack")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#stack"}},[t._v("stack")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.stack")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"error"}})]),t._v(" "),e("h2",{attrs:{id:"static-error"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-error","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" Error")]),t._v(" "),e("p",[e("strong",[t._v("● Error")]),t._v(": "),e("em",[e("code",[t._v("ErrorConstructor")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984")])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"object-literals"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#object-literals","aria-hidden":"true"}},[t._v("#")]),t._v(" Object literals")]),t._v(" "),e("p",[e("a",{attrs:{id:"codes"}})]),t._v(" "),e("h2",{attrs:{id:"static-codes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-codes","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" CODES")]),t._v(" "),e("p",[e("strong",[t._v("CODES")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:60"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("a",{attrs:{id:"codes.assert"}})]),t._v(" "),e("h3",{attrs:{id:"assert"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" ASSERT")]),t._v(" "),e("p",[e("strong",[t._v("● ASSERT")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -90009")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:61"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.invalid_jsonrpc"}})]),t._v(" "),e("h3",{attrs:{id:"invalid-jsonrpc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#invalid-jsonrpc","aria-hidden":"true"}},[t._v("#")]),t._v(" INVALID_JSONRPC")]),t._v(" "),e("p",[e("strong",[t._v("● INVALID_JSONRPC")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -99998")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:63"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.method_not_found"}})]),t._v(" "),e("h3",{attrs:{id:"method-not-found"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#method-not-found","aria-hidden":"true"}},[t._v("#")]),t._v(" METHOD_NOT_FOUND")]),t._v(" "),e("p",[e("strong",[t._v("● METHOD_NOT_FOUND")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -32601")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:64"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.unknown"}})]),t._v(" "),e("h3",{attrs:{id:"unknown"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unknown","aria-hidden":"true"}},[t._v("#")]),t._v(" UNKNOWN")]),t._v(" "),e("p",[e("strong",[t._v("● UNKNOWN")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:62"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/181.b0fd05d9.js b/docs/.vuepress/dist/assets/js/181.265ffcde.js similarity index 87% rename from docs/.vuepress/dist/assets/js/181.b0fd05d9.js rename to docs/.vuepress/dist/assets/js/181.265ffcde.js index a486f6233..989826c8b 100644 --- a/docs/.vuepress/dist/assets/js/181.b0fd05d9.js +++ b/docs/.vuepress/dist/assets/js/181.265ffcde.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{364:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("ExtErrorInterface")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"code"}})]),t._v(" "),r("h2",{attrs:{id:"code"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),r("p",[r("strong",[t._v("● code")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("● data")]),t._v(": "),r("em",[r("code",[t._v("any")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"message"}})]),t._v(" "),r("h2",{attrs:{id:"message"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),r("p",[r("strong",[t._v("● message")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"stack"}})]),t._v(" "),r("h2",{attrs:{id:"stack"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),r("p",[r("strong",[t._v("● stack")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{366:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("ExtErrorInterface")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"code"}})]),t._v(" "),r("h2",{attrs:{id:"code"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),r("p",[r("strong",[t._v("● code")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("● data")]),t._v(": "),r("em",[r("code",[t._v("any")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"message"}})]),t._v(" "),r("h2",{attrs:{id:"message"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),r("p",[r("strong",[t._v("● message")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"stack"}})]),t._v(" "),r("h2",{attrs:{id:"stack"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),r("p",[r("strong",[t._v("● stack")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/182.07ff82a3.js b/docs/.vuepress/dist/assets/js/182.17aac8ce.js similarity index 90% rename from docs/.vuepress/dist/assets/js/182.07ff82a3.js rename to docs/.vuepress/dist/assets/js/182.17aac8ce.js index a4b243a61..310e75a59 100644 --- a/docs/.vuepress/dist/assets/js/182.07ff82a3.js +++ b/docs/.vuepress/dist/assets/js/182.17aac8ce.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{363:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ToBnOptions")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"isle"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isle","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isLe")]),e._v(" "),r("p",[r("strong",[e._v("● isLe")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:24"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnegative"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isnegative"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isnegative","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isNegative")]),e._v(" "),r("p",[r("strong",[e._v("● isNegative")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{365:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ToBnOptions")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"isle"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isle","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isLe")]),e._v(" "),r("p",[r("strong",[e._v("● isLe")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:24"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnegative"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isnegative"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isnegative","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isNegative")]),e._v(" "),r("p",[r("strong",[e._v("● isNegative")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/183.64236942.js b/docs/.vuepress/dist/assets/js/183.497b2283.js similarity index 97% rename from docs/.vuepress/dist/assets/js/183.64236942.js rename to docs/.vuepress/dist/assets/js/183.497b2283.js index fcf17b84b..6ded1af4e 100644 --- a/docs/.vuepress/dist/assets/js/183.64236942.js +++ b/docs/.vuepress/dist/assets/js/183.497b2283.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{362:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"arrayfilter"}})]),t._v(" "),s("h2",{attrs:{id:"arrayfilter"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#arrayfilter","aria-hidden":"true"}},[t._v("#")]),t._v(" arrayFilter")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("arrayFilter")]),t._v("(array: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(", allowNulls?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/array/filter.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("array/filter.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": arrayFilter")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Filters undefined and (optionally) null values from an array")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a new array with all "),s("code",[t._v("undefined")]),t._v(" values removed. Optionally, when "),s("code",[t._v("allowNulls = false")]),t._v(", it removes the "),s("code",[t._v("null")]),t._v(" values as well")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" arrayFilter "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, null, false, '']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, false, '']")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("array")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" allowNulls")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("true")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{364:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"arrayfilter"}})]),t._v(" "),s("h2",{attrs:{id:"arrayfilter"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#arrayfilter","aria-hidden":"true"}},[t._v("#")]),t._v(" arrayFilter")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("arrayFilter")]),t._v("(array: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(", allowNulls?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/array/filter.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("array/filter.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": arrayFilter")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Filters undefined and (optionally) null values from an array")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a new array with all "),s("code",[t._v("undefined")]),t._v(" values removed. Optionally, when "),s("code",[t._v("allowNulls = false")]),t._v(", it removes the "),s("code",[t._v("null")]),t._v(" values as well")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" arrayFilter "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, null, false, '']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, false, '']")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("array")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" allowNulls")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("true")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/184.00a82cca.js b/docs/.vuepress/dist/assets/js/184.478a891c.js similarity index 97% rename from docs/.vuepress/dist/assets/js/184.00a82cca.js rename to docs/.vuepress/dist/assets/js/184.478a891c.js index 6c2b6ba1f..d2305e94c 100644 --- a/docs/.vuepress/dist/assets/js/184.00a82cca.js +++ b/docs/.vuepress/dist/assets/js/184.478a891c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{361:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"assert"}})]),t._v(" "),a("h2",{attrs:{id:"assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" assert")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("assert")]),t._v("<"),a("code",[t._v("T")]),t._v(">(test: "),a("em",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(", message: "),a("em",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(", code?: "),a("em",[a("code",[t._v("number")])]),t._v(", data?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/assert.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("assert.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": assert")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Checks for a valid test, if not ExtError is thrown.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks that "),a("code",[t._v("test")]),t._v(" is a truthy value. If value is falsy ("),a("code",[t._v("null")]),t._v(", "),a("code",[t._v("undefined")]),t._v(", "),a("code",[t._v("false")]),t._v(", ...), it throws an ExtError with the supplied "),a("code",[t._v("message")]),t._v(" and an optional "),a("code",[t._v("code")]),t._v(" and "),a("code",[t._v("data")]),t._v(". When "),a("code",[t._v("test")]),t._v(" passes, "),a("code",[t._v("true")]),t._v(" is returned.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'True should be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// true returned")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'False should not be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError thrown")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError with 'message'")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Type parameters:")])]),t._v(" "),a("h4",{attrs:{id:"t"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("test")]),t._v(" "),a("td",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("ExtError.CODES.ASSERT")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),a("td",[a("code",[t._v("any")])]),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{363:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"assert"}})]),t._v(" "),a("h2",{attrs:{id:"assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" assert")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("assert")]),t._v("<"),a("code",[t._v("T")]),t._v(">(test: "),a("em",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(", message: "),a("em",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(", code?: "),a("em",[a("code",[t._v("number")])]),t._v(", data?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/assert.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("assert.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": assert")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Checks for a valid test, if not ExtError is thrown.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks that "),a("code",[t._v("test")]),t._v(" is a truthy value. If value is falsy ("),a("code",[t._v("null")]),t._v(", "),a("code",[t._v("undefined")]),t._v(", "),a("code",[t._v("false")]),t._v(", ...), it throws an ExtError with the supplied "),a("code",[t._v("message")]),t._v(" and an optional "),a("code",[t._v("code")]),t._v(" and "),a("code",[t._v("data")]),t._v(". When "),a("code",[t._v("test")]),t._v(" passes, "),a("code",[t._v("true")]),t._v(" is returned.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'True should be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// true returned")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'False should not be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError thrown")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError with 'message'")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Type parameters:")])]),t._v(" "),a("h4",{attrs:{id:"t"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("test")]),t._v(" "),a("td",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("ExtError.CODES.ASSERT")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),a("td",[a("code",[t._v("any")])]),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/185.9ea22630.js b/docs/.vuepress/dist/assets/js/185.6c3879cf.js similarity index 79% rename from docs/.vuepress/dist/assets/js/185.9ea22630.js rename to docs/.vuepress/dist/assets/js/185.6c3879cf.js index 0e6defc40..4346a0301 100644 --- a/docs/.vuepress/dist/assets/js/185.9ea22630.js +++ b/docs/.vuepress/dist/assets/js/185.6c3879cf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{360:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{361:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/186.697f2b8f.js b/docs/.vuepress/dist/assets/js/186.77a23514.js similarity index 97% rename from docs/.vuepress/dist/assets/js/186.697f2b8f.js rename to docs/.vuepress/dist/assets/js/186.77a23514.js index 34e5ee552..8732b0e0f 100644 --- a/docs/.vuepress/dist/assets/js/186.697f2b8f.js +++ b/docs/.vuepress/dist/assets/js/186.77a23514.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{359:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntobn"}})]),t._v(" "),s("h2",{attrs:{id:"bntobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntobn","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToBn")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toBn.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN value from a BN.js bignumber or number input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x0")]),t._v(" result, BN values returns the value, numnbers returns a BN representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{360:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntobn"}})]),t._v(" "),s("h2",{attrs:{id:"bntobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntobn","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToBn")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toBn.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN value from a BN.js bignumber or number input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x0")]),t._v(" result, BN values returns the value, numnbers returns a BN representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/187.120ac91f.js b/docs/.vuepress/dist/assets/js/187.765f81a4.js similarity index 97% rename from docs/.vuepress/dist/assets/js/187.120ac91f.js rename to docs/.vuepress/dist/assets/js/187.765f81a4.js index 12202cf83..741a35169 100644 --- a/docs/.vuepress/dist/assets/js/187.120ac91f.js +++ b/docs/.vuepress/dist/assets/js/187.765f81a4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{358:function(t,e,s){"use strict";s.r(e);var n=s(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntohex"}})]),t._v(" "),s("h2",{attrs:{id:"bntohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntohex","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToHex")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(", options?: "),s("em",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toHex.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toHex.ts:33"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex value from a BN.js bignumber object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x")]),t._v(" result, BN values return the actual value as a "),s("code",[t._v("0x")]),t._v(" prefixed hex value. Anything that is not a BN object throws an error. With "),s("code",[t._v("bitLength")]),t._v(" set, it fixes the number to the specified length.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x123456")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x123456'")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v(" "),s("td",[t._v("{ bitLength: -1, isLe: false, isNegative: false }")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{359:function(t,e,s){"use strict";s.r(e);var n=s(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntohex"}})]),t._v(" "),s("h2",{attrs:{id:"bntohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntohex","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToHex")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(", options?: "),s("em",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toHex.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toHex.ts:33"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex value from a BN.js bignumber object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x")]),t._v(" result, BN values return the actual value as a "),s("code",[t._v("0x")]),t._v(" prefixed hex value. Anything that is not a BN object throws an error. With "),s("code",[t._v("bitLength")]),t._v(" set, it fixes the number to the specified length.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x123456")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x123456'")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v(" "),s("td",[t._v("{ bitLength: -1, isLe: false, isNegative: false }")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/188.a8c31bb3.js b/docs/.vuepress/dist/assets/js/188.348a5174.js similarity index 96% rename from docs/.vuepress/dist/assets/js/188.a8c31bb3.js rename to docs/.vuepress/dist/assets/js/188.348a5174.js index 003715a14..a426492b3 100644 --- a/docs/.vuepress/dist/assets/js/188.a8c31bb3.js +++ b/docs/.vuepress/dist/assets/js/188.348a5174.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{357:function(t,e,n){"use strict";n.r(e);var a=n(46),v=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"bntou8a"}})]),t._v(" "),n("h2",{attrs:{id:"bntou8a"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bntou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToU8a")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("code",[t._v("Options")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])]),t._v(", isLe?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toU8a.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": bnToU8a")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a BN.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("Uint8Array")]),t._v(" result. "),n("code",[t._v("BN")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("Uint8Array")]),t._v(". Optionally convert using little-endian format if "),n("code",[t._v("isLE")]),t._v(" is set.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("code",[t._v("Options")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toU8a.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:30"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" isLe")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{358:function(t,e,n){"use strict";n.r(e);var a=n(46),v=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"bntou8a"}})]),t._v(" "),n("h2",{attrs:{id:"bntou8a"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bntou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToU8a")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("code",[t._v("Options")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])]),t._v(", isLe?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": bnToU8a")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a BN.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("Uint8Array")]),t._v(" result. "),n("code",[t._v("BN")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("Uint8Array")]),t._v(". Optionally convert using little-endian format if "),n("code",[t._v("isLE")]),t._v(" is set.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("code",[t._v("Options")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:30"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" isLe")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/189.129825bc.js b/docs/.vuepress/dist/assets/js/189.68693ae1.js similarity index 96% rename from docs/.vuepress/dist/assets/js/189.129825bc.js rename to docs/.vuepress/dist/assets/js/189.68693ae1.js index 8f9634190..accf946f8 100644 --- a/docs/.vuepress/dist/assets/js/189.129825bc.js +++ b/docs/.vuepress/dist/assets/js/189.68693ae1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{356:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"buffertou8a"}})]),t._v(" "),e("h2",{attrs:{id:"buffertou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buffertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bufferToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("bufferToU8a")]),t._v("(buffer?: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/buffer/toU8a.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("buffer/toU8a.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": bufferToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Buffer object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty result, "),e("code",[t._v("Buffer")]),t._v(" values return the actual value as a "),e("code",[t._v("Uint8Array")]),t._v(". Anything that is not a "),e("code",[t._v("Buffer")]),t._v(" object throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bufferToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("bufferToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" buffer")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{357:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"buffertou8a"}})]),t._v(" "),e("h2",{attrs:{id:"buffertou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buffertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bufferToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("bufferToU8a")]),t._v("(buffer?: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/buffer/toU8a.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("buffer/toU8a.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": bufferToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Buffer object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty result, "),e("code",[t._v("Buffer")]),t._v(" values return the actual value as a "),e("code",[t._v("Uint8Array")]),t._v(". Anything that is not a "),e("code",[t._v("Buffer")]),t._v(" object throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bufferToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("bufferToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" buffer")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/19.cbbe0a2a.js b/docs/.vuepress/dist/assets/js/19.abe0aba9.js similarity index 95% rename from docs/.vuepress/dist/assets/js/19.cbbe0a2a.js rename to docs/.vuepress/dist/assets/js/19.abe0aba9.js index e0e1d30de..20584c9f2 100644 --- a/docs/.vuepress/dist/assets/js/19.cbbe0a2a.js +++ b/docs/.vuepress/dist/assets/js/19.abe0aba9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{412:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Cache")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Cache")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{412:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Cache")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Cache")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/190.1821ed8d.js b/docs/.vuepress/dist/assets/js/190.5992cf8d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/190.1821ed8d.js rename to docs/.vuepress/dist/assets/js/190.5992cf8d.js index 62067f004..459131c5e 100644 --- a/docs/.vuepress/dist/assets/js/190.1821ed8d.js +++ b/docs/.vuepress/dist/assets/js/190.5992cf8d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{355:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactaddlength"}})]),t._v(" "),s("h2",{attrs:{id:"compactaddlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactaddlength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactAddLength")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactAddLength")]),t._v("(input: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/addLength.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/addLength.ts:20"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactAddLength")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Adds a length prefix to the input value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactAddLength "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactAddLength")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xbe")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xef")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{356:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactaddlength"}})]),t._v(" "),s("h2",{attrs:{id:"compactaddlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactaddlength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactAddLength")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactAddLength")]),t._v("(input: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/addLength.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/addLength.ts:20"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactAddLength")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Adds a length prefix to the input value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactAddLength "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactAddLength")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xbe")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xef")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/191.c6a356a2.js b/docs/.vuepress/dist/assets/js/191.9561b139.js similarity index 89% rename from docs/.vuepress/dist/assets/js/191.c6a356a2.js rename to docs/.vuepress/dist/assets/js/191.9561b139.js index e0a602c33..0859fd2fc 100644 --- a/docs/.vuepress/dist/assets/js/191.c6a356a2.js +++ b/docs/.vuepress/dist/assets/js/191.9561b139.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{354:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"default_bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"const-default-bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-default-bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" DEFAULT_BITLENGTH")]),t._v(" "),a("p",[a("strong",[t._v("● DEFAULT_BITLENGTH")]),t._v(": "),a("em",[a("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" = 32")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/defaults.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/defaults.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{355:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"default_bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"const-default-bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-default-bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" DEFAULT_BITLENGTH")]),t._v(" "),a("p",[a("strong",[t._v("● DEFAULT_BITLENGTH")]),t._v(": "),a("em",[a("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" = 32")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/defaults.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/defaults.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/192.468792fd.js b/docs/.vuepress/dist/assets/js/192.f7cb00e8.js similarity index 97% rename from docs/.vuepress/dist/assets/js/192.468792fd.js rename to docs/.vuepress/dist/assets/js/192.f7cb00e8.js index bde5828c8..f0dc95733 100644 --- a/docs/.vuepress/dist/assets/js/192.468792fd.js +++ b/docs/.vuepress/dist/assets/js/192.f7cb00e8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[192],{353:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactfromu8a"}})]),t._v(" "),s("h2",{attrs:{id:"compactfromu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactfromu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactFromU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactFromU8a")]),t._v("(_input: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/fromU8a.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/fromU8a.ts:26"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactFromU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Retrievs the offset and encoded length from a compact-prefixed value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactFromU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactFromU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("254")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("255")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'value offset='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'length='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4, 0xffff")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),s("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[192],{354:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactfromu8a"}})]),t._v(" "),s("h2",{attrs:{id:"compactfromu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactfromu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactFromU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactFromU8a")]),t._v("(_input: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/fromU8a.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/fromU8a.ts:26"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactFromU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Retrievs the offset and encoded length from a compact-prefixed value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactFromU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactFromU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("254")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("255")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'value offset='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'length='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4, 0xffff")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),s("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/193.c5c91047.js b/docs/.vuepress/dist/assets/js/193.ec9dac13.js similarity index 97% rename from docs/.vuepress/dist/assets/js/193.c5c91047.js rename to docs/.vuepress/dist/assets/js/193.ec9dac13.js index 08f69a8f9..fd366f31f 100644 --- a/docs/.vuepress/dist/assets/js/193.c5c91047.js +++ b/docs/.vuepress/dist/assets/js/193.ec9dac13.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{352:function(t,a,n){"use strict";n.r(a);var s=n(46),e=Object(s.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"compactstriplength"}})]),t._v(" "),n("h2",{attrs:{id:"compactstriplength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#compactstriplength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactStripLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("compactStripLength")]),t._v("(input: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/stripLength.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/stripLength.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": compactStripLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactStripLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactStripLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<<")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [2, Uint8Array[0xde, 0xad]]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("input")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),n("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{353:function(t,a,n){"use strict";n.r(a);var s=n(46),e=Object(s.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"compactstriplength"}})]),t._v(" "),n("h2",{attrs:{id:"compactstriplength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#compactstriplength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactStripLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("compactStripLength")]),t._v("(input: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/stripLength.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/stripLength.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": compactStripLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactStripLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactStripLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<<")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [2, Uint8Array[0xde, 0xad]]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("input")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),n("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/194.3066aa7c.js b/docs/.vuepress/dist/assets/js/194.91654e88.js similarity index 98% rename from docs/.vuepress/dist/assets/js/194.3066aa7c.js rename to docs/.vuepress/dist/assets/js/194.91654e88.js index fa4cffa56..e13fff50f 100644 --- a/docs/.vuepress/dist/assets/js/194.3066aa7c.js +++ b/docs/.vuepress/dist/assets/js/194.91654e88.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{351:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compacttou8a"}})]),t._v(" "),s("h2",{attrs:{id:"compacttou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compacttou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactToU8a")]),t._v("(_value: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Encodes a number into a compact representation")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("511")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0b11111101, 0b00000111])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{351:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compacttou8a"}})]),t._v(" "),s("h2",{attrs:{id:"compacttou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compacttou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactToU8a")]),t._v("(_value: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Encodes a number into a compact representation")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("511")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0b11111101, 0b00000111])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/195.7dde9b4c.js b/docs/.vuepress/dist/assets/js/195.1089c5be.js similarity index 89% rename from docs/.vuepress/dist/assets/js/195.7dde9b4c.js rename to docs/.vuepress/dist/assets/js/195.1089c5be.js index f6afce4cf..3c2b5950e 100644 --- a/docs/.vuepress/dist/assets/js/195.7dde9b4c.js +++ b/docs/.vuepress/dist/assets/js/195.1089c5be.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[195],{350:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" BitLength")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ BitLength")]),t._v(": "),a("em",[a("code",[t._v("8")]),t._v(" | "),a("code",[t._v("16")]),t._v(" | "),a("code",[t._v("32")]),t._v(" | "),a("code",[t._v("64")]),t._v(" | "),a("code",[t._v("128")]),t._v(" | "),a("code",[t._v("256")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[195],{352:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" BitLength")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ BitLength")]),t._v(": "),a("em",[a("code",[t._v("8")]),t._v(" | "),a("code",[t._v("16")]),t._v(" | "),a("code",[t._v("32")]),t._v(" | "),a("code",[t._v("64")]),t._v(" | "),a("code",[t._v("128")]),t._v(" | "),a("code",[t._v("256")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/196.5358e00f.js b/docs/.vuepress/dist/assets/js/196.46524ef0.js similarity index 91% rename from docs/.vuepress/dist/assets/js/196.5358e00f.js rename to docs/.vuepress/dist/assets/js/196.46524ef0.js index 3e25be5ae..87ef870f3 100644 --- a/docs/.vuepress/dist/assets/js/196.5358e00f.js +++ b/docs/.vuepress/dist/assets/js/196.46524ef0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{349:function(t,r,e){"use strict";e.r(r);var s=e(46),a=Object(s.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{350:function(t,r,e){"use strict";e.r(r);var s=e(46),a=Object(s.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/197.42bd0bbf.js b/docs/.vuepress/dist/assets/js/197.72ae4804.js similarity index 96% rename from docs/.vuepress/dist/assets/js/197.42bd0bbf.js rename to docs/.vuepress/dist/assets/js/197.72ae4804.js index ccb5d97f2..6c05b0d92 100644 --- a/docs/.vuepress/dist/assets/js/197.42bd0bbf.js +++ b/docs/.vuepress/dist/assets/js/197.72ae4804.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{348:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hexaddprefix"}})]),t._v(" "),s("h2",{attrs:{id:"hexaddprefix"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hexaddprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexAddPrefix")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexAddPrefix")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/addPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/addPrefix.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexAddPrefix")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Adds the "),s("code",[t._v("0x")]),t._v(" prefix to string values.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("0x")]),t._v(" prefixed string from the input value. If the input is already prefixed, it is returned unchanged.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexAddPrefix "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'With prefix'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexAddPrefix")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0a0b12'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0a0b12")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{349:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hexaddprefix"}})]),t._v(" "),s("h2",{attrs:{id:"hexaddprefix"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hexaddprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexAddPrefix")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexAddPrefix")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/addPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/addPrefix.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexAddPrefix")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Adds the "),s("code",[t._v("0x")]),t._v(" prefix to string values.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("0x")]),t._v(" prefixed string from the input value. If the input is already prefixed, it is returned unchanged.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexAddPrefix "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'With prefix'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexAddPrefix")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0a0b12'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0a0b12")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/198.66cf471c.js b/docs/.vuepress/dist/assets/js/198.67fc5eb5.js similarity index 98% rename from docs/.vuepress/dist/assets/js/198.66cf471c.js rename to docs/.vuepress/dist/assets/js/198.67fc5eb5.js index 6cc7e7619..2b05c3535 100644 --- a/docs/.vuepress/dist/assets/js/198.66cf471c.js +++ b/docs/.vuepress/dist/assets/js/198.67fc5eb5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[198],{347:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hexfixlength"}})]),t._v(" "),n("h2",{attrs:{id:"hexfixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hexfixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" hexFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("string")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", withPadding?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/fixLength.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/fixLength.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a hex string to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a "),n("code",[t._v("0x")]),t._v(" prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When "),n("code",[t._v("withPadding")]),t._v(" is set, shorter values are padded with "),n("code",[t._v("0")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x0012'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("string")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" withPadding")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[198],{348:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hexfixlength"}})]),t._v(" "),n("h2",{attrs:{id:"hexfixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hexfixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" hexFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("string")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", withPadding?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/fixLength.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/fixLength.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a hex string to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a "),n("code",[t._v("0x")]),t._v(" prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When "),n("code",[t._v("withPadding")]),t._v(" is set, shorter values are padded with "),n("code",[t._v("0")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x0012'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("string")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" withPadding")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/199.f85bd6ee.js b/docs/.vuepress/dist/assets/js/199.24cd895b.js similarity index 98% rename from docs/.vuepress/dist/assets/js/199.f85bd6ee.js rename to docs/.vuepress/dist/assets/js/199.24cd895b.js index 7680d88e6..c3a85ab30 100644 --- a/docs/.vuepress/dist/assets/js/199.f85bd6ee.js +++ b/docs/.vuepress/dist/assets/js/199.24cd895b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{346:function(t,s,e){"use strict";e.r(s);var a=e(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexhasprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexhasprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexhasprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexHasPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexHasPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/hasPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/hasPrefix.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexHasPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Checks for a valid hex input value and if the start matched "),e("code",[t._v("0x")])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexHasPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'has prefix'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexHasPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{346:function(t,s,e){"use strict";e.r(s);var a=e(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexhasprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexhasprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexhasprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexHasPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexHasPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/hasPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/hasPrefix.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexHasPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Checks for a valid hex input value and if the start matched "),e("code",[t._v("0x")])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexHasPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'has prefix'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexHasPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/20.057e0f39.js b/docs/.vuepress/dist/assets/js/20.fec34c17.js similarity index 95% rename from docs/.vuepress/dist/assets/js/20.057e0f39.js rename to docs/.vuepress/dist/assets/js/20.fec34c17.js index e7c875171..bb8727886 100644 --- a/docs/.vuepress/dist/assets/js/20.057e0f39.js +++ b/docs/.vuepress/dist/assets/js/20.fec34c17.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{415:function(t,r,a){"use strict";a.r(r);var e=a(46),s=Object(e.a)({},function(){var t=this,r=t.$createElement,a=t._self._c||r;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("Compact")])]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new Compact")]),t._v("(file: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Compact.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:17"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("file")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"maintain"}})]),t._v(" "),a("h2",{attrs:{id:"maintain"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("maintain")]),t._v("(fn: "),a("em",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Compact.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{415:function(t,r,a){"use strict";a.r(r);var e=a(46),s=Object(e.a)({},function(){var t=this,r=t.$createElement,a=t._self._c||r;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("Compact")])]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new Compact")]),t._v("(file: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:17"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("file")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"maintain"}})]),t._v(" "),a("h2",{attrs:{id:"maintain"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("maintain")]),t._v("(fn: "),a("em",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/200.edcd7da2.js b/docs/.vuepress/dist/assets/js/200.06ea278f.js similarity index 96% rename from docs/.vuepress/dist/assets/js/200.edcd7da2.js rename to docs/.vuepress/dist/assets/js/200.06ea278f.js index 22ac16fb0..cf275a489 100644 --- a/docs/.vuepress/dist/assets/js/200.edcd7da2.js +++ b/docs/.vuepress/dist/assets/js/200.06ea278f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[200],{344:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexstripprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexstripprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexstripprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexStripPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexStripPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/stripPrefix.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/stripPrefix.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexStripPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Strips any leading "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexStripPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'stripped'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexStripPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 1234")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[200],{347:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexstripprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexstripprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexstripprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexStripPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexStripPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/stripPrefix.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/stripPrefix.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexStripPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Strips any leading "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexStripPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'stripped'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexStripPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 1234")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/201.337016cb.js b/docs/.vuepress/dist/assets/js/201.69833266.js similarity index 98% rename from docs/.vuepress/dist/assets/js/201.337016cb.js rename to docs/.vuepress/dist/assets/js/201.69833266.js index dbf616b26..1d5c92b94 100644 --- a/docs/.vuepress/dist/assets/js/201.337016cb.js +++ b/docs/.vuepress/dist/assets/js/201.69833266.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{345:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hextobn"}})]),t._v(" "),n("h2",{attrs:{id:"hextobn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hextobn","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexToBn")]),t._v("(value?: "),n("em",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v("): "),n("code",[t._v("BN")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toBn.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toBn.ts:35"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexToBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a BN.js bignumber object from a hex string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v(" inputs returns a "),n("code",[t._v("BN(0)")]),t._v(" result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the "),n("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x123480001f)")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v(" "),n("td",[t._v("{ isLe: false, isNegative: false }")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("BN")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{345:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hextobn"}})]),t._v(" "),n("h2",{attrs:{id:"hextobn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hextobn","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexToBn")]),t._v("(value?: "),n("em",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v("): "),n("code",[t._v("BN")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toBn.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toBn.ts:35"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexToBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a BN.js bignumber object from a hex string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v(" inputs returns a "),n("code",[t._v("BN(0)")]),t._v(" result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the "),n("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x123480001f)")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v(" "),n("td",[t._v("{ isLe: false, isNegative: false }")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("BN")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/202.2dd54608.js b/docs/.vuepress/dist/assets/js/202.5eecc4e9.js similarity index 96% rename from docs/.vuepress/dist/assets/js/202.2dd54608.js rename to docs/.vuepress/dist/assets/js/202.5eecc4e9.js index 16ca4b642..11cb37332 100644 --- a/docs/.vuepress/dist/assets/js/202.2dd54608.js +++ b/docs/.vuepress/dist/assets/js/202.5eecc4e9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{343:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hextonumber"}})]),t._v(" "),s("h2",{attrs:{id:"hextonumber"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hextonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToNumber")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexToNumber")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toNumber.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toNumber.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexToNumber")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Number value from a Buffer object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns an NaN result, "),s("code",[t._v("hex")]),t._v(" values return the actual value as a "),s("code",[t._v("Number")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToNumber "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToNumber")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x1234")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{344:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hextonumber"}})]),t._v(" "),s("h2",{attrs:{id:"hextonumber"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hextonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToNumber")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexToNumber")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toNumber.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toNumber.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexToNumber")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Number value from a Buffer object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns an NaN result, "),s("code",[t._v("hex")]),t._v(" values return the actual value as a "),s("code",[t._v("Number")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToNumber "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToNumber")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x1234")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/203.084d4cc8.js b/docs/.vuepress/dist/assets/js/203.36b81107.js similarity index 97% rename from docs/.vuepress/dist/assets/js/203.084d4cc8.js rename to docs/.vuepress/dist/assets/js/203.36b81107.js index 8da986ebf..2fcf2bbc7 100644 --- a/docs/.vuepress/dist/assets/js/203.084d4cc8.js +++ b/docs/.vuepress/dist/assets/js/203.36b81107.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{342:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hextou8a"}})]),t._v(" "),e("h2",{attrs:{id:"hextou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hextou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexToU8a")]),t._v("(_value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toU8a.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toU8a.ts:24"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Uint8Array")]),t._v(" result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the "),e("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x80, 0x00, 0x1f])")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x00, 0x80, 0x00, 0x1f])")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{343:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hextou8a"}})]),t._v(" "),e("h2",{attrs:{id:"hextou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hextou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexToU8a")]),t._v("(_value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toU8a.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toU8a.ts:24"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Uint8Array")]),t._v(" result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the "),e("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x80, 0x00, 0x1f])")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x00, 0x80, 0x00, 0x1f])")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/204.82c644ee.js b/docs/.vuepress/dist/assets/js/204.d6cc92ca.js similarity index 96% rename from docs/.vuepress/dist/assets/js/204.82c644ee.js rename to docs/.vuepress/dist/assets/js/204.d6cc92ca.js index 245e18322..4ebf8a538 100644 --- a/docs/.vuepress/dist/assets/js/204.82c644ee.js +++ b/docs/.vuepress/dist/assets/js/204.d6cc92ca.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{341:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isbn"}})]),t._v(" "),n("h2",{attrs:{id:"isbn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isbn","aria-hidden":"true"}},[t._v("#")]),t._v(" isBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isBn")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/bn.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/bn.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("BN")]),t._v(" object instance.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),n("code",[t._v("BN")]),t._v(" (bn.js).")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBn'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{342:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isbn"}})]),t._v(" "),n("h2",{attrs:{id:"isbn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isbn","aria-hidden":"true"}},[t._v("#")]),t._v(" isBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isBn")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/bn.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/bn.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("BN")]),t._v(" object instance.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),n("code",[t._v("BN")]),t._v(" (bn.js).")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBn'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/205.abb4e24a.js b/docs/.vuepress/dist/assets/js/205.b8a7e0cb.js similarity index 95% rename from docs/.vuepress/dist/assets/js/205.abb4e24a.js rename to docs/.vuepress/dist/assets/js/205.b8a7e0cb.js index 940019139..e6f50143a 100644 --- a/docs/.vuepress/dist/assets/js/205.abb4e24a.js +++ b/docs/.vuepress/dist/assets/js/205.b8a7e0cb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{340:function(t,a,s){"use strict";s.r(a);var e=s(46),n=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"isboolean"}})]),t._v(" "),s("h2",{attrs:{id:"isboolean"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isboolean","aria-hidden":"true"}},[t._v("#")]),t._v(" isBoolean")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isBoolean")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/boolean.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/boolean.ts:19"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isBoolean")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a boolean value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript boolean.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBoolean "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBoolean")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{341:function(t,a,s){"use strict";s.r(a);var e=s(46),n=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"isboolean"}})]),t._v(" "),s("h2",{attrs:{id:"isboolean"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isboolean","aria-hidden":"true"}},[t._v("#")]),t._v(" isBoolean")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isBoolean")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/boolean.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/boolean.ts:19"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isBoolean")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a boolean value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript boolean.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBoolean "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBoolean")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/206.d971459a.js b/docs/.vuepress/dist/assets/js/206.d65748de.js similarity index 96% rename from docs/.vuepress/dist/assets/js/206.d971459a.js rename to docs/.vuepress/dist/assets/js/206.d65748de.js index 3ab6acb4e..e02948a38 100644 --- a/docs/.vuepress/dist/assets/js/206.d971459a.js +++ b/docs/.vuepress/dist/assets/js/206.d65748de.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{339:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isbuffer"}})]),t._v(" "),a("h2",{attrs:{id:"isbuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isbuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" isBuffer")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isBuffer")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/buffer.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/buffer.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isBuffer")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Buffer")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Buffer")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBuffer "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBuffer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBuffer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{340:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isbuffer"}})]),t._v(" "),a("h2",{attrs:{id:"isbuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isbuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" isBuffer")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isBuffer")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/buffer.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/buffer.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isBuffer")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Buffer")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Buffer")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBuffer "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBuffer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBuffer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/207.32eb7b19.js b/docs/.vuepress/dist/assets/js/207.27a83dc0.js similarity index 96% rename from docs/.vuepress/dist/assets/js/207.32eb7b19.js rename to docs/.vuepress/dist/assets/js/207.27a83dc0.js index d1632801b..699dd0ae2 100644 --- a/docs/.vuepress/dist/assets/js/207.32eb7b19.js +++ b/docs/.vuepress/dist/assets/js/207.27a83dc0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[207],{338:function(t,s,r){"use strict";r.r(s);var a=r(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"iserror"}})]),t._v(" "),r("h2",{attrs:{id:"iserror"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iserror","aria-hidden":"true"}},[t._v("#")]),t._v(" isError")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("isError")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/error.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/error.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": isError")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Tests for a "),r("code",[t._v("Error")]),t._v(" object instance.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),r("code",[t._v("Error")]),t._v(".")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isError "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isError'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("isError")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[207],{339:function(t,s,r){"use strict";r.r(s);var a=r(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"iserror"}})]),t._v(" "),r("h2",{attrs:{id:"iserror"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iserror","aria-hidden":"true"}},[t._v("#")]),t._v(" isError")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("isError")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/error.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/error.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": isError")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Tests for a "),r("code",[t._v("Error")]),t._v(" object instance.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),r("code",[t._v("Error")]),t._v(".")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isError "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isError'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("isError")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/208.d13e4db6.js b/docs/.vuepress/dist/assets/js/208.33c2f481.js similarity index 96% rename from docs/.vuepress/dist/assets/js/208.d13e4db6.js rename to docs/.vuepress/dist/assets/js/208.33c2f481.js index 1bf5af2de..394a915f5 100644 --- a/docs/.vuepress/dist/assets/js/208.d13e4db6.js +++ b/docs/.vuepress/dist/assets/js/208.33c2f481.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{336:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isfunction"}})]),t._v(" "),n("h2",{attrs:{id:"isfunction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" isFunction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isFunction")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/function.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/function.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isFunction")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("function")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript function.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isFunction "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFunction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{338:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isfunction"}})]),t._v(" "),n("h2",{attrs:{id:"isfunction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" isFunction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isFunction")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/function.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/function.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isFunction")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("function")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript function.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isFunction "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFunction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/209.e5496503.js b/docs/.vuepress/dist/assets/js/209.8498127e.js similarity index 98% rename from docs/.vuepress/dist/assets/js/209.e5496503.js rename to docs/.vuepress/dist/assets/js/209.8498127e.js index 1f8c7c4f3..6a5b7e441 100644 --- a/docs/.vuepress/dist/assets/js/209.e5496503.js +++ b/docs/.vuepress/dist/assets/js/209.8498127e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[209],{337:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"ishex"}})]),t._v(" "),s("h2",{attrs:{id:"ishex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ishex","aria-hidden":"true"}},[t._v("#")]),t._v(" isHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isHex")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v(", ignoreLength?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/hex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/hex.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a "),s("code",[t._v("0x")]),t._v(" prefixed hex string. Optionally ("),s("code",[t._v("bitLength")]),t._v(" !== -1) checks to see if the bitLength is correct.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("-1")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" ignoreLength")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("false")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[209],{337:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"ishex"}})]),t._v(" "),s("h2",{attrs:{id:"ishex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ishex","aria-hidden":"true"}},[t._v("#")]),t._v(" isHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isHex")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v(", ignoreLength?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/hex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/hex.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a "),s("code",[t._v("0x")]),t._v(" prefixed hex string. Optionally ("),s("code",[t._v("bitLength")]),t._v(" !== -1) checks to see if the bitLength is correct.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("-1")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" ignoreLength")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("false")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/21.8bb1e850.js b/docs/.vuepress/dist/assets/js/21.33f3c84a.js similarity index 94% rename from docs/.vuepress/dist/assets/js/21.8bb1e850.js rename to docs/.vuepress/dist/assets/js/21.33f3c84a.js index 1d23c1902..873a86bf2 100644 --- a/docs/.vuepress/dist/assets/js/21.8bb1e850.js +++ b/docs/.vuepress/dist/assets/js/21.33f3c84a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{540:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[t._v("Serialize")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ File")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new File")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/File.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/File.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{302:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[t._v("Serialize")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ File")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new File")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/File.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/File.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/210.c9b9e5f0.js b/docs/.vuepress/dist/assets/js/210.55deda89.js similarity index 96% rename from docs/.vuepress/dist/assets/js/210.c9b9e5f0.js rename to docs/.vuepress/dist/assets/js/210.55deda89.js index 2522309ae..aac854660 100644 --- a/docs/.vuepress/dist/assets/js/210.c9b9e5f0.js +++ b/docs/.vuepress/dist/assets/js/210.55deda89.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{334:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isinstanceof"}})]),t._v(" "),a("h2",{attrs:{id:"isinstanceof"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isinstanceof","aria-hidden":"true"}},[t._v("#")]),t._v(" isInstanceOf")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isInstanceOf")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v(", clazz: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/instanceOf.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/instanceOf.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isInstanceOf")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a instance of a class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is an instance of the test class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isInstanceOf "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isInstanceOf'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isInstanceOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Array"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("clazz")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{336:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isinstanceof"}})]),t._v(" "),a("h2",{attrs:{id:"isinstanceof"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isinstanceof","aria-hidden":"true"}},[t._v("#")]),t._v(" isInstanceOf")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isInstanceOf")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v(", clazz: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/instanceOf.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/instanceOf.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isInstanceOf")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a instance of a class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is an instance of the test class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isInstanceOf "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isInstanceOf'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isInstanceOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Array"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("clazz")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/211.69e758c6.js b/docs/.vuepress/dist/assets/js/211.7e86d5ba.js similarity index 98% rename from docs/.vuepress/dist/assets/js/211.69e758c6.js rename to docs/.vuepress/dist/assets/js/211.7e86d5ba.js index 6e2923fbd..95f26cf2a 100644 --- a/docs/.vuepress/dist/assets/js/211.69e758c6.js +++ b/docs/.vuepress/dist/assets/js/211.7e86d5ba.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[211],{335:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isip"}})]),t._v(" "),a("h2",{attrs:{id:"isip"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isip","aria-hidden":"true"}},[t._v("#")]),t._v(" isIp")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isIp")]),t._v("(value: "),a("em",[a("code",[t._v("string")])]),t._v(", type?: "),a("em",[a("code",[t._v("IpTypes")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/ip.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/ip.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isIp")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests if the value is a valid IP address")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the value is a valid IP address. Optionally check for either v4/v6")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isIp "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v6'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v4'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" type")]),t._v(" "),a("td",[a("code",[t._v("IpTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[211],{335:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isip"}})]),t._v(" "),a("h2",{attrs:{id:"isip"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isip","aria-hidden":"true"}},[t._v("#")]),t._v(" isIp")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isIp")]),t._v("(value: "),a("em",[a("code",[t._v("string")])]),t._v(", type?: "),a("em",[a("code",[t._v("IpTypes")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/ip.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/ip.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isIp")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests if the value is a valid IP address")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the value is a valid IP address. Optionally check for either v4/v6")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isIp "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v6'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v4'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" type")]),t._v(" "),a("td",[a("code",[t._v("IpTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/212.a80de859.js b/docs/.vuepress/dist/assets/js/212.d7390e95.js similarity index 96% rename from docs/.vuepress/dist/assets/js/212.a80de859.js rename to docs/.vuepress/dist/assets/js/212.d7390e95.js index 33b782159..e06759045 100644 --- a/docs/.vuepress/dist/assets/js/212.a80de859.js +++ b/docs/.vuepress/dist/assets/js/212.d7390e95.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{333:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnull"}})]),t._v(" "),a("h2",{attrs:{id:"isnull"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[t._v("#")]),t._v(" isNull")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNull")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/null.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/null.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNull")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("null")]),t._v(" values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),a("code",[t._v("null")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNull "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNull'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNull")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{334:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnull"}})]),t._v(" "),a("h2",{attrs:{id:"isnull"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[t._v("#")]),t._v(" isNull")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNull")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/null.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/null.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNull")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("null")]),t._v(" values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),a("code",[t._v("null")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNull "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNull'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNull")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/213.5fe7df75.js b/docs/.vuepress/dist/assets/js/213.693cbd68.js similarity index 96% rename from docs/.vuepress/dist/assets/js/213.5fe7df75.js rename to docs/.vuepress/dist/assets/js/213.693cbd68.js index b8b3e7da0..c731324ce 100644 --- a/docs/.vuepress/dist/assets/js/213.5fe7df75.js +++ b/docs/.vuepress/dist/assets/js/213.693cbd68.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[213],{332:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnumber"}})]),t._v(" "),a("h2",{attrs:{id:"isnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" isNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNumber")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/number.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/number.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a JavaScript number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a valid number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNumber'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[213],{333:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnumber"}})]),t._v(" "),a("h2",{attrs:{id:"isnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" isNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNumber")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/number.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/number.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a JavaScript number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a valid number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNumber'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/214.5435961d.js b/docs/.vuepress/dist/assets/js/214.b58aaf1c.js similarity index 96% rename from docs/.vuepress/dist/assets/js/214.5435961d.js rename to docs/.vuepress/dist/assets/js/214.b58aaf1c.js index 233e77a55..a38f77fdc 100644 --- a/docs/.vuepress/dist/assets/js/214.5435961d.js +++ b/docs/.vuepress/dist/assets/js/214.b58aaf1c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{331:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isobject"}})]),t._v(" "),a("h2",{attrs:{id:"isobject"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobject","aria-hidden":"true"}},[t._v("#")]),t._v(" isObject")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isObject")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/object.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/object.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isObject")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for an "),a("code",[t._v("object")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript object.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isObject "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'something'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{332:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isobject"}})]),t._v(" "),a("h2",{attrs:{id:"isobject"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobject","aria-hidden":"true"}},[t._v("#")]),t._v(" isObject")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isObject")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/object.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/object.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isObject")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for an "),a("code",[t._v("object")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript object.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isObject "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'something'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/215.727a447c.js b/docs/.vuepress/dist/assets/js/215.b803123d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/215.727a447c.js rename to docs/.vuepress/dist/assets/js/215.b803123d.js index 4f4901a8f..c496cfa93 100644 --- a/docs/.vuepress/dist/assets/js/215.727a447c.js +++ b/docs/.vuepress/dist/assets/js/215.b803123d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{330:function(s,t,a){"use strict";a.r(t);var e=a(46),n=Object(e.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[s._v("#")]),s._v(" Functions")]),s._v(" "),a("p",[a("a",{attrs:{id:"isobservable"}})]),s._v(" "),a("h2",{attrs:{id:"isobservable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobservable","aria-hidden":"true"}},[s._v("#")]),s._v(" isObservable")]),s._v(" "),a("p",[s._v("▸ "),a("strong",[s._v("isObservable")]),s._v("(value: "),a("em",[a("code",[s._v("any")])]),s._v("): "),a("code",[s._v("boolean")])]),s._v(" "),a("p",[a("em",[s._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/observable.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[s._v("is/observable.ts:26"),a("OutboundLink")],1)])]),s._v(" "),a("p",[a("em",[a("strong",[s._v("name")])]),s._v(": isBObservable")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("summary")])]),s._v(": Tests for a "),a("code",[s._v("Observable")]),s._v(" object instance.")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("description")])]),s._v(": Checks to see if the input object is an instance of "),a("code",[s._v("BN")]),s._v(" (bn.js).")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("example")])]),s._v(":")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" isObservable "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'isObservable'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("isObservable")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br")])]),a("p",[a("strong",[s._v("Parameters:")])]),s._v(" "),a("table",[a("thead",[a("tr",[a("th",[s._v("Name")]),s._v(" "),a("th",[s._v("Type")])])]),s._v(" "),a("tbody",[a("tr",[a("td",[s._v("value")]),s._v(" "),a("td",[a("code",[s._v("any")])])])])]),s._v(" "),a("p",[a("strong",[s._v("Returns:")]),s._v(" "),a("code",[s._v("boolean")])]),s._v(" "),a("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{331:function(s,t,a){"use strict";a.r(t);var e=a(46),n=Object(e.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[s._v("#")]),s._v(" Functions")]),s._v(" "),a("p",[a("a",{attrs:{id:"isobservable"}})]),s._v(" "),a("h2",{attrs:{id:"isobservable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobservable","aria-hidden":"true"}},[s._v("#")]),s._v(" isObservable")]),s._v(" "),a("p",[s._v("▸ "),a("strong",[s._v("isObservable")]),s._v("(value: "),a("em",[a("code",[s._v("any")])]),s._v("): "),a("code",[s._v("boolean")])]),s._v(" "),a("p",[a("em",[s._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/observable.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[s._v("is/observable.ts:26"),a("OutboundLink")],1)])]),s._v(" "),a("p",[a("em",[a("strong",[s._v("name")])]),s._v(": isBObservable")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("summary")])]),s._v(": Tests for a "),a("code",[s._v("Observable")]),s._v(" object instance.")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("description")])]),s._v(": Checks to see if the input object is an instance of "),a("code",[s._v("BN")]),s._v(" (bn.js).")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("example")])]),s._v(":")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" isObservable "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'isObservable'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("isObservable")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br")])]),a("p",[a("strong",[s._v("Parameters:")])]),s._v(" "),a("table",[a("thead",[a("tr",[a("th",[s._v("Name")]),s._v(" "),a("th",[s._v("Type")])])]),s._v(" "),a("tbody",[a("tr",[a("td",[s._v("value")]),s._v(" "),a("td",[a("code",[s._v("any")])])])])]),s._v(" "),a("p",[a("strong",[s._v("Returns:")]),s._v(" "),a("code",[s._v("boolean")])]),s._v(" "),a("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/216.7f69ae44.js b/docs/.vuepress/dist/assets/js/216.e6d7df8e.js similarity index 96% rename from docs/.vuepress/dist/assets/js/216.7f69ae44.js rename to docs/.vuepress/dist/assets/js/216.e6d7df8e.js index 729a74f44..2e5973eca 100644 --- a/docs/.vuepress/dist/assets/js/216.7f69ae44.js +++ b/docs/.vuepress/dist/assets/js/216.e6d7df8e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{329:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isstring"}})]),t._v(" "),n("h2",{attrs:{id:"isstring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isstring","aria-hidden":"true"}},[t._v("#")]),t._v(" isString")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isString")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/string.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/string.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isString")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isString "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isString'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{330:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isstring"}})]),t._v(" "),n("h2",{attrs:{id:"isstring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isstring","aria-hidden":"true"}},[t._v("#")]),t._v(" isString")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isString")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/string.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/string.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isString")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isString "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isString'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/217.3aa9129d.js b/docs/.vuepress/dist/assets/js/217.f1faffcf.js similarity index 96% rename from docs/.vuepress/dist/assets/js/217.3aa9129d.js rename to docs/.vuepress/dist/assets/js/217.f1faffcf.js index 1a9d47fa4..a9e6052ad 100644 --- a/docs/.vuepress/dist/assets/js/217.3aa9129d.js +++ b/docs/.vuepress/dist/assets/js/217.f1faffcf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{328:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isu8a"}})]),t._v(" "),a("h2",{attrs:{id:"isu8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" isU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/u8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/u8a.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Uint8Array")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUint8Array "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{329:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isu8a"}})]),t._v(" "),a("h2",{attrs:{id:"isu8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" isU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/u8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/u8a.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Uint8Array")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUint8Array "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/218.7f1c75ad.js b/docs/.vuepress/dist/assets/js/218.b545b399.js similarity index 94% rename from docs/.vuepress/dist/assets/js/218.7f1c75ad.js rename to docs/.vuepress/dist/assets/js/218.b545b399.js index c3d0f8703..85f5b2930 100644 --- a/docs/.vuepress/dist/assets/js/218.7f1c75ad.js +++ b/docs/.vuepress/dist/assets/js/218.b545b399.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{327:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isundefined"}})]),t._v(" "),n("h2",{attrs:{id:"isundefined"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isundefined","aria-hidden":"true"}},[t._v("#")]),t._v(" isUndefined")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isUndefined")]),t._v("(value?: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/undefined.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/undefined.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isUndefined")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("undefined")]),t._v(" values.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),n("code",[t._v("undefined")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUndefined "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isUndefined'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isUndefined")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{328:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isundefined"}})]),t._v(" "),n("h2",{attrs:{id:"isundefined"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isundefined","aria-hidden":"true"}},[t._v("#")]),t._v(" isUndefined")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isUndefined")]),t._v("(value?: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/undefined.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/undefined.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isUndefined")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("undefined")]),t._v(" values.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),n("code",[t._v("undefined")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUndefined "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isUndefined'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isUndefined")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/219.16cd7973.js b/docs/.vuepress/dist/assets/js/219.d691d2fa.js similarity index 95% rename from docs/.vuepress/dist/assets/js/219.16cd7973.js rename to docs/.vuepress/dist/assets/js/219.d691d2fa.js index 2b7c68866..004a47451 100644 --- a/docs/.vuepress/dist/assets/js/219.16cd7973.js +++ b/docs/.vuepress/dist/assets/js/219.d691d2fa.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{326:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"format"}})]),t._v(" "),s("h2",{attrs:{id:"format"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#format","aria-hidden":"true"}},[t._v("#")]),t._v(" format")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("format")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("any")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/logger.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:42"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"logger"}})]),t._v(" "),s("h2",{attrs:{id:"logger"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" logger")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("logger")]),t._v("(_type: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/logger.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:104"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": Logger")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a consistent log interface for messages")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Logger")]),t._v(" that has "),s("code",[t._v(".log")]),t._v(", "),s("code",[t._v(".error")]),t._v(", "),s("code",[t._v(".warn")]),t._v(" and "),s("code",[t._v(".debug")]),t._v(" (controlled with environment "),s("code",[t._v("DEBUG=typeA,typeB")]),t._v(") methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" l "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/logger'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blah'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// TEST: blah")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_type")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{327:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"format"}})]),t._v(" "),s("h2",{attrs:{id:"format"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#format","aria-hidden":"true"}},[t._v("#")]),t._v(" format")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("format")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("any")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:42"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"logger"}})]),t._v(" "),s("h2",{attrs:{id:"logger"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" logger")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("logger")]),t._v("(_type: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:104"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": Logger")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a consistent log interface for messages")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Logger")]),t._v(" that has "),s("code",[t._v(".log")]),t._v(", "),s("code",[t._v(".error")]),t._v(", "),s("code",[t._v(".warn")]),t._v(" and "),s("code",[t._v(".debug")]),t._v(" (controlled with environment "),s("code",[t._v("DEBUG=typeA,typeB")]),t._v(") methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" l "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/logger'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blah'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// TEST: blah")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_type")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/22.1f367a16.js b/docs/.vuepress/dist/assets/js/22.b3e519f1.js similarity index 95% rename from docs/.vuepress/dist/assets/js/22.1f367a16.js rename to docs/.vuepress/dist/assets/js/22.b3e519f1.js index c0c678b5f..13f7cf828 100644 --- a/docs/.vuepress/dist/assets/js/22.1f367a16.js +++ b/docs/.vuepress/dist/assets/js/22.b3e519f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{302:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Impl")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Impl")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{540:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Impl")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Impl")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/220.b09949a1.js b/docs/.vuepress/dist/assets/js/220.732ab40d.js similarity index 97% rename from docs/.vuepress/dist/assets/js/220.b09949a1.js rename to docs/.vuepress/dist/assets/js/220.732ab40d.js index ab00aca03..5ea3cbf9f 100644 --- a/docs/.vuepress/dist/assets/js/220.b09949a1.js +++ b/docs/.vuepress/dist/assets/js/220.732ab40d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{325:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"numbertohex"}})]),t._v(" "),n("h2",{attrs:{id:"numbertohex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#numbertohex","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToHex")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("numberToHex")]),t._v("(value?: "),n("em",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/number/toHex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toHex.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": numberToHex")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a hex value from a number.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("0x")]),t._v(" result. "),n("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("hex")]),t._v(". With "),n("code",[t._v("bitLength")]),t._v(" set, it converts the number to the equivalent size.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToHex "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x1234'")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x00001234")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{326:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"numbertohex"}})]),t._v(" "),n("h2",{attrs:{id:"numbertohex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#numbertohex","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToHex")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("numberToHex")]),t._v("(value?: "),n("em",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toHex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toHex.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": numberToHex")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a hex value from a number.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("0x")]),t._v(" result. "),n("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("hex")]),t._v(". With "),n("code",[t._v("bitLength")]),t._v(" set, it converts the number to the equivalent size.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToHex "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x1234'")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x00001234")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/221.56e0fcbe.js b/docs/.vuepress/dist/assets/js/221.3ab0b29e.js similarity index 96% rename from docs/.vuepress/dist/assets/js/221.56e0fcbe.js rename to docs/.vuepress/dist/assets/js/221.3ab0b29e.js index d6202e303..ed77a9802 100644 --- a/docs/.vuepress/dist/assets/js/221.56e0fcbe.js +++ b/docs/.vuepress/dist/assets/js/221.3ab0b29e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{324:function(t,e,a){"use strict";a.r(e);var n=a(46),r=Object(n.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"numbertou8a"}})]),t._v(" "),a("h2",{attrs:{id:"numbertou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#numbertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("numberToU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/number/toU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toU8a.ts:22"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": numberToU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("null")]),t._v("/"),a("code",[t._v("undefined")]),t._v("/"),a("code",[t._v("NaN")]),t._v(" inputs returns an empty "),a("code",[t._v("Uint8Array")]),t._v(" result. "),a("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),a("code",[t._v("Uint8Array")]),t._v(". With "),a("code",[t._v("bitLength")]),t._v(", it converts the value to the equivalent size.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("-1")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{325:function(t,e,a){"use strict";a.r(e);var n=a(46),r=Object(n.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"numbertou8a"}})]),t._v(" "),a("h2",{attrs:{id:"numbertou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#numbertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("numberToU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toU8a.ts:22"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": numberToU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("null")]),t._v("/"),a("code",[t._v("undefined")]),t._v("/"),a("code",[t._v("NaN")]),t._v(" inputs returns an empty "),a("code",[t._v("Uint8Array")]),t._v(" result. "),a("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),a("code",[t._v("Uint8Array")]),t._v(". With "),a("code",[t._v("bitLength")]),t._v(", it converts the value to the equivalent size.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("-1")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/222.23e27253.js b/docs/.vuepress/dist/assets/js/222.23e27253.js deleted file mode 100644 index a5442b867..000000000 --- a/docs/.vuepress/dist/assets/js/222.23e27253.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{323:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/222.b6d99e16.js b/docs/.vuepress/dist/assets/js/222.b6d99e16.js new file mode 100644 index 000000000..86a890ea5 --- /dev/null +++ b/docs/.vuepress/dist/assets/js/222.b6d99e16.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{324:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/224.30f758f2.js b/docs/.vuepress/dist/assets/js/224.30f758f2.js new file mode 100644 index 000000000..2031007b9 --- /dev/null +++ b/docs/.vuepress/dist/assets/js/224.30f758f2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{323:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/224.86d3897b.js b/docs/.vuepress/dist/assets/js/224.86d3897b.js deleted file mode 100644 index 9046a04c8..000000000 --- a/docs/.vuepress/dist/assets/js/224.86d3897b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{321:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/225.93a35929.js b/docs/.vuepress/dist/assets/js/225.93a35929.js new file mode 100644 index 000000000..64b3045b9 --- /dev/null +++ b/docs/.vuepress/dist/assets/js/225.93a35929.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{321:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/225.f73f3b5a.js b/docs/.vuepress/dist/assets/js/225.f73f3b5a.js deleted file mode 100644 index 4933be04c..000000000 --- a/docs/.vuepress/dist/assets/js/225.f73f3b5a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{320:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/226.75250bb2.js b/docs/.vuepress/dist/assets/js/226.75250bb2.js deleted file mode 100644 index d1d423d81..000000000 --- a/docs/.vuepress/dist/assets/js/226.75250bb2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{318:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/226.8dea9412.js b/docs/.vuepress/dist/assets/js/226.8dea9412.js new file mode 100644 index 000000000..1b2a26fa4 --- /dev/null +++ b/docs/.vuepress/dist/assets/js/226.8dea9412.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{320:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/228.62bd613a.js b/docs/.vuepress/dist/assets/js/228.3374c974.js similarity index 96% rename from docs/.vuepress/dist/assets/js/228.62bd613a.js rename to docs/.vuepress/dist/assets/js/228.3374c974.js index 0af8b0d52..abcfa4cfe 100644 --- a/docs/.vuepress/dist/assets/js/228.62bd613a.js +++ b/docs/.vuepress/dist/assets/js/228.3374c974.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{317:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"promisify"}})]),t._v(" "),a("h2",{attrs:{id:"promisify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#promisify","aria-hidden":"true"}},[t._v("#")]),t._v(" promisify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("promisify")]),t._v("(self: "),a("em",[a("code",[t._v("any")])]),t._v(", fn: "),a("em",[a("code",[t._v("Function")])]),t._v(", ...params: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/promisify.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("promisify.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": promisify")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Wraps an async callback into a "),a("code",[t._v("Promise")])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Wraps the supplied async function "),a("code",[t._v("fn")]),t._v(" that has a standard JS callback "),a("code",[t._v("(error: Error, result: any)")]),t._v(" into a "),a("code",[t._v("Promise")]),t._v(", passing the supplied parameters. When "),a("code",[t._v("error")]),t._v(" is set, the Promise is rejected, else the Promise resolves with the "),a("code",[t._v("result")]),t._v(" value.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" promisify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resolves with `true`")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'error!'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rejects with `error!`")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("self")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("code",[t._v("Function")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" params")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{318:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"promisify"}})]),t._v(" "),a("h2",{attrs:{id:"promisify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#promisify","aria-hidden":"true"}},[t._v("#")]),t._v(" promisify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("promisify")]),t._v("(self: "),a("em",[a("code",[t._v("any")])]),t._v(", fn: "),a("em",[a("code",[t._v("Function")])]),t._v(", ...params: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/promisify.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("promisify.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": promisify")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Wraps an async callback into a "),a("code",[t._v("Promise")])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Wraps the supplied async function "),a("code",[t._v("fn")]),t._v(" that has a standard JS callback "),a("code",[t._v("(error: Error, result: any)")]),t._v(" into a "),a("code",[t._v("Promise")]),t._v(", passing the supplied parameters. When "),a("code",[t._v("error")]),t._v(" is set, the Promise is rejected, else the Promise resolves with the "),a("code",[t._v("result")]),t._v(" value.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" promisify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resolves with `true`")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'error!'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rejects with `error!`")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("self")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("code",[t._v("Function")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" params")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/229.168cc500.js b/docs/.vuepress/dist/assets/js/229.168cc500.js new file mode 100644 index 000000000..0546a2ab4 --- /dev/null +++ b/docs/.vuepress/dist/assets/js/229.168cc500.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{317:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/229.1930c09b.js b/docs/.vuepress/dist/assets/js/229.1930c09b.js deleted file mode 100644 index 9095b6b22..000000000 --- a/docs/.vuepress/dist/assets/js/229.1930c09b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{316:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/230.384ad2ea.js b/docs/.vuepress/dist/assets/js/230.67d69ce6.js similarity index 94% rename from docs/.vuepress/dist/assets/js/230.384ad2ea.js rename to docs/.vuepress/dist/assets/js/230.67d69ce6.js index be64dca02..ba7cfdee4 100644 --- a/docs/.vuepress/dist/assets/js/230.384ad2ea.js +++ b/docs/.vuepress/dist/assets/js/230.67d69ce6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{315:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringlowerfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringlowerfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringlowerfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringLowerFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringLowerFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/lowerFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/lowerFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringLowerFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringLowerFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringLowerFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ABC'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'aBC'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{316:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringlowerfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringlowerfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringlowerfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringLowerFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringLowerFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/lowerFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/lowerFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringLowerFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringLowerFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringLowerFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ABC'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'aBC'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/231.645c2800.js b/docs/.vuepress/dist/assets/js/231.b3ed861d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/231.645c2800.js rename to docs/.vuepress/dist/assets/js/231.b3ed861d.js index 0334349a3..9231aaeac 100644 --- a/docs/.vuepress/dist/assets/js/231.645c2800.js +++ b/docs/.vuepress/dist/assets/js/231.b3ed861d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{314:function(t,s,n){"use strict";n.r(s);var e=n(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"stringshorten"}})]),t._v(" "),n("h2",{attrs:{id:"stringshorten"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stringshorten","aria-hidden":"true"}},[t._v("#")]),t._v(" stringShorten")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("stringShorten")]),t._v("(_value?: "),n("em",[n("code",[t._v("any")])]),t._v(", prefixLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/shorten.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/shorten.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": stringShorten")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Returns a string with maximum length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks the string against the "),n("code",[t._v("prefixLength")]),t._v(", if longer than dopuble this, shortens it by placing "),n("code",[t._v("..")]),t._v(" in the middle of it")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringShorten "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringShorten")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1234567890'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 12..90")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),n("td",[n("code",[t._v("any")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" prefixLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("6")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{315:function(t,s,n){"use strict";n.r(s);var e=n(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"stringshorten"}})]),t._v(" "),n("h2",{attrs:{id:"stringshorten"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stringshorten","aria-hidden":"true"}},[t._v("#")]),t._v(" stringShorten")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("stringShorten")]),t._v("(_value?: "),n("em",[n("code",[t._v("any")])]),t._v(", prefixLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/shorten.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/shorten.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": stringShorten")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Returns a string with maximum length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks the string against the "),n("code",[t._v("prefixLength")]),t._v(", if longer than dopuble this, shortens it by placing "),n("code",[t._v("..")]),t._v(" in the middle of it")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringShorten "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringShorten")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1234567890'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 12..90")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),n("td",[n("code",[t._v("any")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" prefixLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("6")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/232.6142c00c.js b/docs/.vuepress/dist/assets/js/232.67759a82.js similarity index 96% rename from docs/.vuepress/dist/assets/js/232.6142c00c.js rename to docs/.vuepress/dist/assets/js/232.67759a82.js index dc1186a8a..0df709318 100644 --- a/docs/.vuepress/dist/assets/js/232.6142c00c.js +++ b/docs/.vuepress/dist/assets/js/232.67759a82.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{313:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"stringtou8a"}})]),t._v(" "),s("h2",{attrs:{id:"stringtou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#stringtou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" stringToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("stringToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/toU8a.ts:39"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": stringToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a utf-8 string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": String input values return the actual encoded "),s("code",[t._v("UInt8Array")]),t._v(". "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty encoded array.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hello'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0x68, 0x65, 0x6c, 0x6c, 0x6f]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{314:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"stringtou8a"}})]),t._v(" "),s("h2",{attrs:{id:"stringtou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#stringtou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" stringToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("stringToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/toU8a.ts:39"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": stringToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a utf-8 string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": String input values return the actual encoded "),s("code",[t._v("UInt8Array")]),t._v(". "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty encoded array.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hello'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0x68, 0x65, 0x6c, 0x6c, 0x6f]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/233.8e826a8c.js b/docs/.vuepress/dist/assets/js/233.6411d217.js similarity index 94% rename from docs/.vuepress/dist/assets/js/233.8e826a8c.js rename to docs/.vuepress/dist/assets/js/233.6411d217.js index bd8c03b96..048ab39bd 100644 --- a/docs/.vuepress/dist/assets/js/233.8e826a8c.js +++ b/docs/.vuepress/dist/assets/js/233.6411d217.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[233],{312:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringupperfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringupperfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringupperfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringUpperFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringUpperFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/upperFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/upperFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringUpperFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringUpperFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringUpperFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'Abc'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[233],{313:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringupperfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringupperfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringupperfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringUpperFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringUpperFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/upperFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/upperFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringUpperFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringUpperFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringUpperFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'Abc'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/234.064493fe.js b/docs/.vuepress/dist/assets/js/234.215b2134.js similarity index 91% rename from docs/.vuepress/dist/assets/js/234.064493fe.js rename to docs/.vuepress/dist/assets/js/234.215b2134.js index 68f1f0c30..5f34e0735 100644 --- a/docs/.vuepress/dist/assets/js/234.064493fe.js +++ b/docs/.vuepress/dist/assets/js/234.215b2134.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{311:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"syncify"}})]),t._v(" "),n("h2",{attrs:{id:"syncify"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#syncify","aria-hidden":"true"}},[t._v("#")]),t._v(" syncify")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("syncify")]),t._v("(promise: "),n("em",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")]),t._v("): "),n("code",[t._v("any")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/syncify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("syncify.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("promise")]),t._v(" "),n("td",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("any")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{312:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"syncify"}})]),t._v(" "),n("h2",{attrs:{id:"syncify"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#syncify","aria-hidden":"true"}},[t._v("#")]),t._v(" syncify")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("syncify")]),t._v("(promise: "),n("em",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")]),t._v("): "),n("code",[t._v("any")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/syncify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("syncify.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("promise")]),t._v(" "),n("td",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("any")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/235.48a166d3.js b/docs/.vuepress/dist/assets/js/235.bb6bf091.js similarity index 93% rename from docs/.vuepress/dist/assets/js/235.48a166d3.js rename to docs/.vuepress/dist/assets/js/235.bb6bf091.js index 428578458..61d383117 100644 --- a/docs/.vuepress/dist/assets/js/235.48a166d3.js +++ b/docs/.vuepress/dist/assets/js/235.bb6bf091.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{310:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")])],1)]),t._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger_data"}},[t._v("Logger$Data")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"logger"}})]),t._v(" "),a("h2",{attrs:{id:"logger"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"logger_data"}})]),t._v(" "),a("h2",{attrs:{id:"logger-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger-data","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger$Data")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger$Data")]),t._v(": "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(" | "),a("code",[t._v("Logger$Data$Fn")]),t._v(">")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{311:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")])],1)]),t._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger_data"}},[t._v("Logger$Data")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"logger"}})]),t._v(" "),a("h2",{attrs:{id:"logger"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"logger_data"}})]),t._v(" "),a("h2",{attrs:{id:"logger-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger-data","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger$Data")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger$Data")]),t._v(": "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(" | "),a("code",[t._v("Logger$Data$Fn")]),t._v(">")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/236.598d6932.js b/docs/.vuepress/dist/assets/js/236.a1743b72.js similarity index 97% rename from docs/.vuepress/dist/assets/js/236.598d6932.js rename to docs/.vuepress/dist/assets/js/236.a1743b72.js index a48574f45..74b7310e2 100644 --- a/docs/.vuepress/dist/assets/js/236.598d6932.js +++ b/docs/.vuepress/dist/assets/js/236.a1743b72.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{309:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8aconcat"}})]),t._v(" "),s("h2",{attrs:{id:"u8aconcat"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8aconcat","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aConcat")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aConcat")]),t._v("(..._list: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/concat.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/concat.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aConcat")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a concatenated Uint8Array from the inputs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Concatenates the input arrays into a single "),s("code",[t._v("UInt8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aConcat "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aConcat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [1, 2, 3, 4, 5, 6]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Rest")]),t._v(" _list")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{310:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8aconcat"}})]),t._v(" "),s("h2",{attrs:{id:"u8aconcat"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8aconcat","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aConcat")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aConcat")]),t._v("(..._list: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/concat.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/concat.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aConcat")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a concatenated Uint8Array from the inputs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Concatenates the input arrays into a single "),s("code",[t._v("UInt8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aConcat "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aConcat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [1, 2, 3, 4, 5, 6]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Rest")]),t._v(" _list")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/237.cfa0779c.js b/docs/.vuepress/dist/assets/js/237.cf91c6d9.js similarity index 97% rename from docs/.vuepress/dist/assets/js/237.cfa0779c.js rename to docs/.vuepress/dist/assets/js/237.cf91c6d9.js index f99cd92a6..e622f66ea 100644 --- a/docs/.vuepress/dist/assets/js/237.cfa0779c.js +++ b/docs/.vuepress/dist/assets/js/237.cf91c6d9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{308:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"u8afixlength"}})]),t._v(" "),n("h2",{attrs:{id:"u8afixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#u8afixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("u8aFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", atStart?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/fixLength.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/fixLength.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": u8aFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a Uint8Array to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" atStart")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{309:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"u8afixlength"}})]),t._v(" "),n("h2",{attrs:{id:"u8afixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#u8afixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("u8aFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", atStart?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/fixLength.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/fixLength.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": u8aFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a Uint8Array to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" atStart")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/238.18bbe2e6.js b/docs/.vuepress/dist/assets/js/238.daad0e47.js similarity index 97% rename from docs/.vuepress/dist/assets/js/238.18bbe2e6.js rename to docs/.vuepress/dist/assets/js/238.daad0e47.js index a84a47939..8c114ac81 100644 --- a/docs/.vuepress/dist/assets/js/238.18bbe2e6.js +++ b/docs/.vuepress/dist/assets/js/238.daad0e47.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{307:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atobn"}})]),t._v(" "),s("h2",{attrs:{id:"u8atobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atobn","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToBn")]),t._v("(value: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v(", options?: "),s("em",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toBn.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBn.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual BN. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an "),s("code",[t._v("0x0")]),t._v(" value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("The value to convert")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v(" "),s("td",[t._v("{ isLe: true, isNegative: false }")]),t._v(" "),s("td",[t._v("Options to pass while converting")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{308:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atobn"}})]),t._v(" "),s("h2",{attrs:{id:"u8atobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atobn","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToBn")]),t._v("(value: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v(", options?: "),s("em",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBn.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBn.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual BN. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an "),s("code",[t._v("0x0")]),t._v(" value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("The value to convert")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v(" "),s("td",[t._v("{ isLe: true, isNegative: false }")]),t._v(" "),s("td",[t._v("Options to pass while converting")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/239.c2592333.js b/docs/.vuepress/dist/assets/js/239.140e9afc.js similarity index 96% rename from docs/.vuepress/dist/assets/js/239.c2592333.js rename to docs/.vuepress/dist/assets/js/239.140e9afc.js index cc950856e..a2132cf82 100644 --- a/docs/.vuepress/dist/assets/js/239.c2592333.js +++ b/docs/.vuepress/dist/assets/js/239.140e9afc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{306:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atobuffer"}})]),t._v(" "),e("h2",{attrs:{id:"u8atobuffer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atobuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBuffer")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToBuffer")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Buffer")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toBuffer.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBuffer.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToBuffer")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Buffer")]),t._v(" result. "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual bytes value converted to a "),e("code",[t._v("Buffer")]),t._v(". Anything that is not a "),e("code",[t._v("UInt8Array")]),t._v(" throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBuffer "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Buffer'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToBuffer")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Buffer")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{307:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atobuffer"}})]),t._v(" "),e("h2",{attrs:{id:"u8atobuffer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atobuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBuffer")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToBuffer")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Buffer")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBuffer.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBuffer.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToBuffer")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Buffer")]),t._v(" result. "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual bytes value converted to a "),e("code",[t._v("Buffer")]),t._v(". Anything that is not a "),e("code",[t._v("UInt8Array")]),t._v(" throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBuffer "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Buffer'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToBuffer")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Buffer")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/24.5bf00e17.js b/docs/.vuepress/dist/assets/js/24.cde54b27.js similarity index 97% rename from docs/.vuepress/dist/assets/js/24.5bf00e17.js rename to docs/.vuepress/dist/assets/js/24.cde54b27.js index bd085a4d9..157eecf83 100644 --- a/docs/.vuepress/dist/assets/js/24.5bf00e17.js +++ b/docs/.vuepress/dist/assets/js/24.cde54b27.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{427:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": MemoryDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a MemoryDb database extending TransactionDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Memory database using MemoryDb and extending TransactionDb. "),n("code",[t._v("options")]),t._v(" argument (optional) used to specifies whether to use compression.")]),t._v(" "),n("ul",[n("li",[t._v('Enable compression when storing "blocks" since they compress well.')]),t._v(" "),n("li",[t._v('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')])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" MemoryDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Memory'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" memoryDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MemoryDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from memory db")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from memory db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ Memory")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new Memory")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/Memory.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Memory.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{427:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": MemoryDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a MemoryDb database extending TransactionDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Memory database using MemoryDb and extending TransactionDb. "),n("code",[t._v("options")]),t._v(" argument (optional) used to specifies whether to use compression.")]),t._v(" "),n("ul",[n("li",[t._v('Enable compression when storing "blocks" since they compress well.')]),t._v(" "),n("li",[t._v('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')])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" MemoryDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Memory'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" memoryDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MemoryDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from memory db")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from memory db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ Memory")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new Memory")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Memory.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Memory.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/240.e2449758.js b/docs/.vuepress/dist/assets/js/240.4390c353.js similarity index 97% rename from docs/.vuepress/dist/assets/js/240.e2449758.js rename to docs/.vuepress/dist/assets/js/240.4390c353.js index 56aaaf1b1..f3eb49826 100644 --- a/docs/.vuepress/dist/assets/js/240.e2449758.js +++ b/docs/.vuepress/dist/assets/js/240.4390c353.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{304:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atohex"}})]),t._v(" "),e("h2",{attrs:{id:"u8atohex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atohex","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToHex")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", isPrefixed?: "),e("em",[e("code",[t._v("boolean")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toHex.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a hex string from a Uint8Array object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual hex string. "),e("code",[t._v("null")]),t._v(" or "),e("code",[t._v("undefined")]),t._v(" values returns an "),e("code",[t._v("0x")]),t._v(" string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" isPrefixed")]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("true")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{306:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atohex"}})]),t._v(" "),e("h2",{attrs:{id:"u8atohex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atohex","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToHex")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", isPrefixed?: "),e("em",[e("code",[t._v("boolean")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toHex.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a hex string from a Uint8Array object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual hex string. "),e("code",[t._v("null")]),t._v(" or "),e("code",[t._v("undefined")]),t._v(" values returns an "),e("code",[t._v("0x")]),t._v(" string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" isPrefixed")]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("true")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/241.f37b512b.js b/docs/.vuepress/dist/assets/js/241.d3f5e4de.js similarity index 97% rename from docs/.vuepress/dist/assets/js/241.f37b512b.js rename to docs/.vuepress/dist/assets/js/241.d3f5e4de.js index 383ce65d8..591d409be 100644 --- a/docs/.vuepress/dist/assets/js/241.f37b512b.js +++ b/docs/.vuepress/dist/assets/js/241.d3f5e4de.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{421:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atostring"}})]),t._v(" "),s("h2",{attrs:{id:"u8atostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atostring","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToString")]),t._v("(value?: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toString.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toString.ts:35"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToString")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a utf-8 string from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual decoded utf-8 string. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToString "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6f")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hello")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{303:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atostring"}})]),t._v(" "),s("h2",{attrs:{id:"u8atostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atostring","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToString")]),t._v("(value?: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toString.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toString.ts:35"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToString")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a utf-8 string from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual decoded utf-8 string. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToString "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6f")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hello")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/242.11733b21.js b/docs/.vuepress/dist/assets/js/242.733a2eb7.js similarity index 97% rename from docs/.vuepress/dist/assets/js/242.11733b21.js rename to docs/.vuepress/dist/assets/js/242.733a2eb7.js index 317682031..445269cf9 100644 --- a/docs/.vuepress/dist/assets/js/242.11733b21.js +++ b/docs/.vuepress/dist/assets/js/242.733a2eb7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{303:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atou8a"}})]),t._v(" "),s("h2",{attrs:{id:"u8atou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Uint8Array bignumber or hex input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("[]")]),t._v(" result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x34")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{304:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atou8a"}})]),t._v(" "),s("h2",{attrs:{id:"u8atou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Uint8Array bignumber or hex input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("[]")]),t._v(" result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x34")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/25.45d9ba34.js b/docs/.vuepress/dist/assets/js/25.d80e6990.js similarity index 93% rename from docs/.vuepress/dist/assets/js/25.45d9ba34.js rename to docs/.vuepress/dist/assets/js/25.d80e6990.js index 50204e173..1ecb60927 100644 --- a/docs/.vuepress/dist/assets/js/25.45d9ba34.js +++ b/docs/.vuepress/dist/assets/js/25.d80e6990.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{430:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{430:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/26.d5793cba.js b/docs/.vuepress/dist/assets/js/26.bce2e7e5.js similarity index 92% rename from docs/.vuepress/dist/assets/js/26.d5793cba.js rename to docs/.vuepress/dist/assets/js/26.bce2e7e5.js index 8c6fecbfa..4afc138d3 100644 --- a/docs/.vuepress/dist/assets/js/26.d5793cba.js +++ b/docs/.vuepress/dist/assets/js/26.bce2e7e5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{433:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("BaseDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[t._v("FileTreeDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{433:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("BaseDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[t._v("FileTreeDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/27.9e614eb8.js b/docs/.vuepress/dist/assets/js/27.fc38d8b0.js similarity index 94% rename from docs/.vuepress/dist/assets/js/27.9e614eb8.js rename to docs/.vuepress/dist/assets/js/27.fc38d8b0.js index c0b9ba3aa..77d3e3def 100644 --- a/docs/.vuepress/dist/assets/js/27.9e614eb8.js +++ b/docs/.vuepress/dist/assets/js/27.fc38d8b0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{436:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ TxDb")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{436:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ TxDb")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/32.cc8c279a.js b/docs/.vuepress/dist/assets/js/32.c9b1699b.js similarity index 91% rename from docs/.vuepress/dist/assets/js/32.cc8c279a.js rename to docs/.vuepress/dist/assets/js/32.c9b1699b.js index 3e9f25aec..e69e68275 100644 --- a/docs/.vuepress/dist/assets/js/32.cc8c279a.js +++ b/docs/.vuepress/dist/assets/js/32.c9b1699b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{454:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{451:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/33.79625a51.js b/docs/.vuepress/dist/assets/js/33.9cd88591.js similarity index 91% rename from docs/.vuepress/dist/assets/js/33.79625a51.js rename to docs/.vuepress/dist/assets/js/33.9cd88591.js index 5910f28ed..88f951945 100644 --- a/docs/.vuepress/dist/assets/js/33.79625a51.js +++ b/docs/.vuepress/dist/assets/js/33.9cd88591.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{451:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{454:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/36.dc25d366.js b/docs/.vuepress/dist/assets/js/36.e712ae96.js similarity index 91% rename from docs/.vuepress/dist/assets/js/36.dc25d366.js rename to docs/.vuepress/dist/assets/js/36.e712ae96.js index f760d5713..99aab9503 100644 --- a/docs/.vuepress/dist/assets/js/36.dc25d366.js +++ b/docs/.vuepress/dist/assets/js/36.e712ae96.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{466:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{463:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/37.f4bbb54b.js b/docs/.vuepress/dist/assets/js/37.e2bf13b0.js similarity index 91% rename from docs/.vuepress/dist/assets/js/37.f4bbb54b.js rename to docs/.vuepress/dist/assets/js/37.e2bf13b0.js index 8f32ed3b3..b306268e1 100644 --- a/docs/.vuepress/dist/assets/js/37.f4bbb54b.js +++ b/docs/.vuepress/dist/assets/js/37.e2bf13b0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{463:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{466:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/39.0dbd64fc.js b/docs/.vuepress/dist/assets/js/39.eeddab89.js similarity index 93% rename from docs/.vuepress/dist/assets/js/39.0dbd64fc.js rename to docs/.vuepress/dist/assets/js/39.eeddab89.js index a47bcb79f..0fb8d85b4 100644 --- a/docs/.vuepress/dist/assets/js/39.0dbd64fc.js +++ b/docs/.vuepress/dist/assets/js/39.eeddab89.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{472:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"enumerations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html"}},[e._v("Slot")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#key"}},[e._v("Key")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#nibblebuffer"}},[e._v("NibbleBuffer")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#value"}},[e._v("Value")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"key"}})]),e._v(" "),a("h2",{attrs:{id:"key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[e._v("#")]),e._v(" Key")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Key")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:16"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"nibblebuffer"}})]),e._v(" "),a("h2",{attrs:{id:"nibblebuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#nibblebuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" NibbleBuffer")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ NibbleBuffer")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:11"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"value"}})]),e._v(" "),a("h2",{attrs:{id:"value"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" Value")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Value")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:22"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{472:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"enumerations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html"}},[e._v("Slot")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#key"}},[e._v("Key")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#nibblebuffer"}},[e._v("NibbleBuffer")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#value"}},[e._v("Value")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"key"}})]),e._v(" "),a("h2",{attrs:{id:"key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[e._v("#")]),e._v(" Key")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Key")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:16"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"nibblebuffer"}})]),e._v(" "),a("h2",{attrs:{id:"nibblebuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#nibblebuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" NibbleBuffer")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ NibbleBuffer")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:11"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"value"}})]),e._v(" "),a("h2",{attrs:{id:"value"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" Value")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Value")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:22"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/41.054b5bd7.js b/docs/.vuepress/dist/assets/js/41.e1f4f49a.js similarity index 94% rename from docs/.vuepress/dist/assets/js/41.054b5bd7.js rename to docs/.vuepress/dist/assets/js/41.e1f4f49a.js index b693526d3..5af04b78f 100644 --- a/docs/.vuepress/dist/assets/js/41.054b5bd7.js +++ b/docs/.vuepress/dist/assets/js/41.e1f4f49a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{481:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"basedboptions"}})]),t._v(" "),r("h2",{attrs:{id:"basedboptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#basedboptions","aria-hidden":"true"}},[t._v("#")]),t._v(" BaseDbOptions")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ BaseDbOptions")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progresscb"}})]),t._v(" "),r("h2",{attrs:{id:"progresscb"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progresscb","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressCb")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressCb")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(progress: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("progress")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progressvalue"}})]),t._v(" "),r("h2",{attrs:{id:"progressvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progressvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressValue")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressValue")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{478:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"basedboptions"}})]),t._v(" "),r("h2",{attrs:{id:"basedboptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#basedboptions","aria-hidden":"true"}},[t._v("#")]),t._v(" BaseDbOptions")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ BaseDbOptions")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progresscb"}})]),t._v(" "),r("h2",{attrs:{id:"progresscb"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progresscb","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressCb")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressCb")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(progress: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("progress")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progressvalue"}})]),t._v(" "),r("h2",{attrs:{id:"progressvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progressvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressValue")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressValue")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/42.16285beb.js b/docs/.vuepress/dist/assets/js/42.7f31bca0.js similarity index 99% rename from docs/.vuepress/dist/assets/js/42.16285beb.js rename to docs/.vuepress/dist/assets/js/42.7f31bca0.js index 6d855b4ca..0270aa912 100644 --- a/docs/.vuepress/dist/assets/js/42.16285beb.js +++ b/docs/.vuepress/dist/assets/js/42.7f31bca0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{478:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"create-account"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-account","aria-hidden":"true"}},[t._v("#")]),t._v(" Create Account")]),t._v(" "),a("p",[t._v("The following example shows how to create and account with keyring.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import Keyring class and utility function")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create account seed for Alice")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("' '")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an instance of the Keyring")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Keyring")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create pair and add Alice to keyring pair dictionary (with account seed)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pairAlice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Created keyring pair for Alice with address: `")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pairAlice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{481:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"create-account"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-account","aria-hidden":"true"}},[t._v("#")]),t._v(" Create Account")]),t._v(" "),a("p",[t._v("The following example shows how to create and account with keyring.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import Keyring class and utility function")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create account seed for Alice")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("' '")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an instance of the Keyring")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Keyring")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create pair and add Alice to keyring pair dictionary (with account seed)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pairAlice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Created keyring pair for Alice with address: `")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pairAlice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/52.4e84ed63.js b/docs/.vuepress/dist/assets/js/52.07201cd3.js similarity index 91% rename from docs/.vuepress/dist/assets/js/52.4e84ed63.js rename to docs/.vuepress/dist/assets/js/52.07201cd3.js index f0768e4a8..e9bac836d 100644 --- a/docs/.vuepress/dist/assets/js/52.4e84ed63.js +++ b/docs/.vuepress/dist/assets/js/52.07201cd3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{458:function(s,t,e){"use strict";e.r(t);var i=e(46),a=Object(i.a)({},function(){var s=this.$createElement,t=this._self._c||s;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"sign-verify-message-using-nacl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sign-verify-message-using-nacl","aria-hidden":"true"}},[this._v("#")]),this._v(" Sign & Verify Message using NaCl")]),this._v(" "),t("p",[this._v('The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.')]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{421:function(s,t,e){"use strict";e.r(t);var i=e(46),a=Object(i.a)({},function(){var s=this.$createElement,t=this._self._c||s;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"sign-verify-message-using-nacl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sign-verify-message-using-nacl","aria-hidden":"true"}},[this._v("#")]),this._v(" Sign & Verify Message using NaCl")]),this._v(" "),t("p",[this._v('The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.')]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/54.f47073f6.js b/docs/.vuepress/dist/assets/js/54.36b1fbcd.js similarity index 95% rename from docs/.vuepress/dist/assets/js/54.f47073f6.js rename to docs/.vuepress/dist/assets/js/54.36b1fbcd.js index f1e07dfeb..f84d41f43 100644 --- a/docs/.vuepress/dist/assets/js/54.f47073f6.js +++ b/docs/.vuepress/dist/assets/js/54.36b1fbcd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{419:function(e,t,a){"use strict";a.r(t);var n=a(46),s=Object(n.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"util-crypto-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#util-crypto-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Util-Crypto Examples")]),e._v(" "),a("p",[e._v("Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.")]),e._v(" "),a("h2",{attrs:{id:"running-the-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#running-the-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Running the examples")]),e._v(" "),a("p",[e._v("From within each folder run the following to install required dependencies and to execute the example:")]),e._v(" "),a("div",{staticClass:"language-shell line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("yarn;\nyarn start\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br")])])])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{473:function(e,t,a){"use strict";a.r(t);var n=a(46),s=Object(n.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"util-crypto-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#util-crypto-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Util-Crypto Examples")]),e._v(" "),a("p",[e._v("Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.")]),e._v(" "),a("h2",{attrs:{id:"running-the-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#running-the-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Running the examples")]),e._v(" "),a("p",[e._v("From within each folder run the following to install required dependencies and to execute the example:")]),e._v(" "),a("div",{staticClass:"language-shell line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("yarn;\nyarn start\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br")])])])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/57.6800590a.js b/docs/.vuepress/dist/assets/js/57.541a883c.js similarity index 93% rename from docs/.vuepress/dist/assets/js/57.6800590a.js rename to docs/.vuepress/dist/assets/js/57.541a883c.js index c40dbe201..4e54f5f7d 100644 --- a/docs/.vuepress/dist/assets/js/57.6800590a.js +++ b/docs/.vuepress/dist/assets/js/57.541a883c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{517:function(r,t,e){"use strict";e.r(t);var a=e(46),s=Object(a.a)({},function(){var r=this,t=r.$createElement,e=r._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("p",[e("strong",[r._v("Pairs")])]),r._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[r._v("#")]),r._v(" Implements")]),r._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[r._v("KeyringPairs")])],1)]),r._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[r._v("#")]),r._v(" Constructors")]),r._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),r._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[r._v("#")]),r._v(" constructor")]),r._v(" "),e("p",[r._v("⊕ "),e("strong",[r._v("new Pairs")]),r._v("(): "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:17"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("hr"),r._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),r._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[r._v("#")]),r._v(" add")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("add")]),r._v("(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:23"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("pair")]),r._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),r._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[r._v("#")]),r._v(" all")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("all")]),r._v("(): "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:30"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),r._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[r._v("#")]),r._v(" get")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("get")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:34"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),r._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[r._v("#")]),r._v(" remove")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("remove")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("code",[r._v("void")])]),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:49"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("void")])]),r._v(" "),e("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{517:function(r,t,e){"use strict";e.r(t);var a=e(46),s=Object(a.a)({},function(){var r=this,t=r.$createElement,e=r._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("p",[e("strong",[r._v("Pairs")])]),r._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[r._v("#")]),r._v(" Implements")]),r._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[r._v("KeyringPairs")])],1)]),r._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[r._v("#")]),r._v(" Constructors")]),r._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),r._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[r._v("#")]),r._v(" constructor")]),r._v(" "),e("p",[r._v("⊕ "),e("strong",[r._v("new Pairs")]),r._v("(): "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:17"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("hr"),r._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),r._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[r._v("#")]),r._v(" add")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("add")]),r._v("(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:23"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("pair")]),r._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),r._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[r._v("#")]),r._v(" all")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("all")]),r._v("(): "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:30"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),r._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[r._v("#")]),r._v(" get")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("get")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:34"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),r._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[r._v("#")]),r._v(" remove")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("remove")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("code",[r._v("void")])]),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:49"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("void")])]),r._v(" "),e("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/58.89c55e19.js b/docs/.vuepress/dist/assets/js/58.434d2ad0.js similarity index 94% rename from docs/.vuepress/dist/assets/js/58.89c55e19.js rename to docs/.vuepress/dist/assets/js/58.434d2ad0.js index 968873163..bf34c849a 100644 --- a/docs/.vuepress/dist/assets/js/58.89c55e19.js +++ b/docs/.vuepress/dist/assets/js/58.434d2ad0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{520:function(r,e,t){"use strict";t.r(e);var a=t(46),_=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),t("p",[t("strong",[r._v("KeyringInstance")])]),r._v(" "),t("h1",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),t("p",[t("a",{attrs:{id:"pairs"}})]),r._v(" "),t("h2",{attrs:{id:"pairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pairs","aria-hidden":"true"}},[r._v("#")]),r._v(" pairs")]),r._v(" "),t("p",[t("strong",[r._v("● pairs")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:58"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"publickeys"}})]),r._v(" "),t("h2",{attrs:{id:"publickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" publicKeys")]),r._v(" "),t("p",[t("strong",[r._v("● publicKeys")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:59"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"type"}})]),r._v(" "),t("h2",{attrs:{id:"type"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[r._v("#")]),r._v(" type")]),r._v(" "),t("p",[t("strong",[r._v("● type")]),r._v(": "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:60"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),t("p",[t("a",{attrs:{id:"addfromaddress"}})]),r._v(" "),t("h2",{attrs:{id:"addfromaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromAddress")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", encoded?: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])]),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:67"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" encoded")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromjson"}})]),r._v(" "),t("h2",{attrs:{id:"addfromjson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromjson","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromJson")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:70"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfrommnemonic"}})]),r._v(" "),t("h2",{attrs:{id:"addfrommnemonic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfrommnemonic","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromMnemonic")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromMnemonic")]),r._v("(mnemonic: "),t("em",[t("code",[r._v("string")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:68"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("mnemonic")]),r._v(" "),t("td",[t("code",[r._v("string")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromseed"}})]),r._v(" "),t("h2",{attrs:{id:"addfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromseed","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromSeed")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromSeed")]),r._v("(seed: "),t("em",[t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:69"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("seed")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addpair"}})]),r._v(" "),t("h2",{attrs:{id:"addpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addpair","aria-hidden":"true"}},[r._v("#")]),r._v(" addPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addPair")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:66"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"decodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"decodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" decodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("decodeAddress")]),r._v("(encoded: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:62"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("encoded")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"encodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"encodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" encodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("encodeAddress")]),r._v("(key: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("code",[r._v("string")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:63"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("key")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("string")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpair"}})]),r._v(" "),t("h2",{attrs:{id:"getpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[r._v("#")]),r._v(" getPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:71"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpairs"}})]),r._v(" "),t("h2",{attrs:{id:"getpairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[r._v("#")]),r._v(" getPairs")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPairs")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:72"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpublickeys"}})]),r._v(" "),t("h2",{attrs:{id:"getpublickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpublickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" getPublicKeys")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPublicKeys")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:73"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"removepair"}})]),r._v(" "),t("h2",{attrs:{id:"removepair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removepair","aria-hidden":"true"}},[r._v("#")]),r._v(" removePair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("removePair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:74"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"setaddressprefix"}})]),r._v(" "),t("h2",{attrs:{id:"setaddressprefix"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setaddressprefix","aria-hidden":"true"}},[r._v("#")]),r._v(" setAddressPrefix")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("setAddressPrefix")]),r._v("(prefix: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:64"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("prefix")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"tojson"}})]),r._v(" "),t("h2",{attrs:{id:"tojson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[r._v("#")]),r._v(" toJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("toJson")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", passphrase?: "),t("em",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:75"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" passphrase")]),r._v(" "),t("td",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{520:function(r,e,t){"use strict";t.r(e);var a=t(46),_=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),t("p",[t("strong",[r._v("KeyringInstance")])]),r._v(" "),t("h1",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),t("p",[t("a",{attrs:{id:"pairs"}})]),r._v(" "),t("h2",{attrs:{id:"pairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pairs","aria-hidden":"true"}},[r._v("#")]),r._v(" pairs")]),r._v(" "),t("p",[t("strong",[r._v("● pairs")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:58"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"publickeys"}})]),r._v(" "),t("h2",{attrs:{id:"publickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" publicKeys")]),r._v(" "),t("p",[t("strong",[r._v("● publicKeys")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:59"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"type"}})]),r._v(" "),t("h2",{attrs:{id:"type"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[r._v("#")]),r._v(" type")]),r._v(" "),t("p",[t("strong",[r._v("● type")]),r._v(": "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:60"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),t("p",[t("a",{attrs:{id:"addfromaddress"}})]),r._v(" "),t("h2",{attrs:{id:"addfromaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromAddress")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", encoded?: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])]),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:67"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" encoded")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromjson"}})]),r._v(" "),t("h2",{attrs:{id:"addfromjson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromjson","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromJson")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:70"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfrommnemonic"}})]),r._v(" "),t("h2",{attrs:{id:"addfrommnemonic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfrommnemonic","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromMnemonic")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromMnemonic")]),r._v("(mnemonic: "),t("em",[t("code",[r._v("string")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:68"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("mnemonic")]),r._v(" "),t("td",[t("code",[r._v("string")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromseed"}})]),r._v(" "),t("h2",{attrs:{id:"addfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromseed","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromSeed")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromSeed")]),r._v("(seed: "),t("em",[t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:69"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("seed")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addpair"}})]),r._v(" "),t("h2",{attrs:{id:"addpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addpair","aria-hidden":"true"}},[r._v("#")]),r._v(" addPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addPair")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:66"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"decodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"decodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" decodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("decodeAddress")]),r._v("(encoded: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:62"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("encoded")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"encodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"encodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" encodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("encodeAddress")]),r._v("(key: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("code",[r._v("string")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:63"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("key")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("string")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpair"}})]),r._v(" "),t("h2",{attrs:{id:"getpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[r._v("#")]),r._v(" getPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:71"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpairs"}})]),r._v(" "),t("h2",{attrs:{id:"getpairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[r._v("#")]),r._v(" getPairs")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPairs")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:72"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpublickeys"}})]),r._v(" "),t("h2",{attrs:{id:"getpublickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpublickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" getPublicKeys")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPublicKeys")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:73"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"removepair"}})]),r._v(" "),t("h2",{attrs:{id:"removepair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removepair","aria-hidden":"true"}},[r._v("#")]),r._v(" removePair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("removePair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:74"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"setaddressprefix"}})]),r._v(" "),t("h2",{attrs:{id:"setaddressprefix"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setaddressprefix","aria-hidden":"true"}},[r._v("#")]),r._v(" setAddressPrefix")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("setAddressPrefix")]),r._v("(prefix: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:64"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("prefix")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"tojson"}})]),r._v(" "),t("h2",{attrs:{id:"tojson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[r._v("#")]),r._v(" toJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("toJson")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", passphrase?: "),t("em",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:75"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" passphrase")]),r._v(" "),t("td",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/59.1693a50f.js b/docs/.vuepress/dist/assets/js/59.dc6dac5c.js similarity index 94% rename from docs/.vuepress/dist/assets/js/59.1693a50f.js rename to docs/.vuepress/dist/assets/js/59.dc6dac5c.js index 7359ba730..44076cec8 100644 --- a/docs/.vuepress/dist/assets/js/59.1693a50f.js +++ b/docs/.vuepress/dist/assets/js/59.dc6dac5c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{523:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("KeyringPair")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"address"}})]),t._v(" "),r("h2",{attrs:{id:"address"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#address","aria-hidden":"true"}},[t._v("#")]),t._v(" address")]),t._v(" "),r("p",[r("strong",[t._v("● address")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"decodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" decodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● decodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(", encoded?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"encodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" encodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● encodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getmeta"}})]),t._v(" "),r("h2",{attrs:{id:"getmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),r("p",[r("strong",[t._v("● getMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"islocked"}})]),t._v(" "),r("h2",{attrs:{id:"islocked"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#islocked","aria-hidden":"true"}},[t._v("#")]),t._v(" isLocked")]),t._v(" "),r("p",[r("strong",[t._v("● isLocked")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"lock"}})]),t._v(" "),r("h2",{attrs:{id:"lock"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lock","aria-hidden":"true"}},[t._v("#")]),t._v(" lock")]),t._v(" "),r("p",[r("strong",[t._v("● lock")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"publickey"}})]),t._v(" "),r("h2",{attrs:{id:"publickey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#publickey","aria-hidden":"true"}},[t._v("#")]),t._v(" publicKey")]),t._v(" "),r("p",[r("strong",[t._v("● publicKey")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setmeta"}})]),t._v(" "),r("h2",{attrs:{id:"setmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" setMeta")]),t._v(" "),r("p",[r("strong",[t._v("● setMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(meta: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("● type")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"totype"}})]),t._v(" "),r("h2",{attrs:{id:"totype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#totype","aria-hidden":"true"}},[t._v("#")]),t._v(" toType")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toType")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v("): "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"verify"}})]),t._v(" "),r("h2",{attrs:{id:"verify"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#verify","aria-hidden":"true"}},[t._v("#")]),t._v(" verify")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("verify")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{523:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("KeyringPair")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"address"}})]),t._v(" "),r("h2",{attrs:{id:"address"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#address","aria-hidden":"true"}},[t._v("#")]),t._v(" address")]),t._v(" "),r("p",[r("strong",[t._v("● address")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"decodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" decodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● decodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(", encoded?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"encodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" encodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● encodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getmeta"}})]),t._v(" "),r("h2",{attrs:{id:"getmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),r("p",[r("strong",[t._v("● getMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"islocked"}})]),t._v(" "),r("h2",{attrs:{id:"islocked"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#islocked","aria-hidden":"true"}},[t._v("#")]),t._v(" isLocked")]),t._v(" "),r("p",[r("strong",[t._v("● isLocked")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"lock"}})]),t._v(" "),r("h2",{attrs:{id:"lock"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lock","aria-hidden":"true"}},[t._v("#")]),t._v(" lock")]),t._v(" "),r("p",[r("strong",[t._v("● lock")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"publickey"}})]),t._v(" "),r("h2",{attrs:{id:"publickey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#publickey","aria-hidden":"true"}},[t._v("#")]),t._v(" publicKey")]),t._v(" "),r("p",[r("strong",[t._v("● publicKey")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setmeta"}})]),t._v(" "),r("h2",{attrs:{id:"setmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" setMeta")]),t._v(" "),r("p",[r("strong",[t._v("● setMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(meta: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("● type")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"totype"}})]),t._v(" "),r("h2",{attrs:{id:"totype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#totype","aria-hidden":"true"}},[t._v("#")]),t._v(" toType")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toType")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v("): "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"verify"}})]),t._v(" "),r("h2",{attrs:{id:"verify"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#verify","aria-hidden":"true"}},[t._v("#")]),t._v(" verify")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("verify")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/60.df9f0823.js b/docs/.vuepress/dist/assets/js/60.e830d4c9.js similarity index 95% rename from docs/.vuepress/dist/assets/js/60.df9f0823.js rename to docs/.vuepress/dist/assets/js/60.e830d4c9.js index 40aea14d3..38f59f0d3 100644 --- a/docs/.vuepress/dist/assets/js/60.df9f0823.js +++ b/docs/.vuepress/dist/assets/js/60.e830d4c9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{526:function(t,r,e){"use strict";e.r(r);var a=e(46),i=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("KeyringPairs")])]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)]),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),t._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[e("strong",[t._v("● add")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:51"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("pair")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),t._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[t._v("#")]),t._v(" all")]),t._v(" "),e("p",[e("strong",[t._v("● all")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:52"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(): "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),t._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),e("p",[e("strong",[t._v("● get")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:53"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),t._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[e("strong",[t._v("● remove")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:54"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{526:function(t,r,e){"use strict";e.r(r);var a=e(46),i=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("KeyringPairs")])]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)]),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),t._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[e("strong",[t._v("● add")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:51"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("pair")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),t._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[t._v("#")]),t._v(" all")]),t._v(" "),e("p",[e("strong",[t._v("● all")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:52"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(): "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),t._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),e("p",[e("strong",[t._v("● get")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:53"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),t._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[e("strong",[t._v("● remove")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:54"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/61.81d8c0e5.js b/docs/.vuepress/dist/assets/js/61.a5c6d657.js similarity index 96% rename from docs/.vuepress/dist/assets/js/61.81d8c0e5.js rename to docs/.vuepress/dist/assets/js/61.a5c6d657.js index 8d0958ec5..08e6edaf2 100644 --- a/docs/.vuepress/dist/assets/js/61.81d8c0e5.js +++ b/docs/.vuepress/dist/assets/js/61.a5c6d657.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{529:function(e,t,r){"use strict";r.r(t);var d=r(46),_=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(encoded: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/decode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/decode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("encoded")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{529:function(e,t,r){"use strict";r.r(t);var d=r(46),_=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(encoded: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/decode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/decode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("encoded")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/63.232727b4.js b/docs/.vuepress/dist/assets/js/63.44b784a4.js similarity index 96% rename from docs/.vuepress/dist/assets/js/63.232727b4.js rename to docs/.vuepress/dist/assets/js/63.44b784a4.js index 5d4526ca1..49d2e1e24 100644 --- a/docs/.vuepress/dist/assets/js/63.232727b4.js +++ b/docs/.vuepress/dist/assets/js/63.44b784a4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{535:function(e,t,r){"use strict";r.r(t);var _=r(46),s=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(_key: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/encode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/encode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{535:function(e,t,r){"use strict";r.r(t);var _=r(46),s=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(_key: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/encode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/encode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/64.be248631.js b/docs/.vuepress/dist/assets/js/64.0b302571.js similarity index 95% rename from docs/.vuepress/dist/assets/js/64.be248631.js rename to docs/.vuepress/dist/assets/js/64.0b302571.js index d97fe87e5..e9d3ac647 100644 --- a/docs/.vuepress/dist/assets/js/64.be248631.js +++ b/docs/.vuepress/dist/assets/js/64.0b302571.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{538:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"setprefix"}})]),t._v(" "),r("h2",{attrs:{id:"setprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" setPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setPrefix")]),t._v("(prefix: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/setPrefix.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("address/setPrefix.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("prefix")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{538:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"setprefix"}})]),t._v(" "),r("h2",{attrs:{id:"setprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" setPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setPrefix")]),t._v("(prefix: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/setPrefix.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("address/setPrefix.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("prefix")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/65.c9b7e6d2.js b/docs/.vuepress/dist/assets/js/65.c59be25f.js similarity index 94% rename from docs/.vuepress/dist/assets/js/65.c9b7e6d2.js rename to docs/.vuepress/dist/assets/js/65.c59be25f.js index 5e6335350..fb05a1074 100644 --- a/docs/.vuepress/dist/assets/js/65.c9b7e6d2.js +++ b/docs/.vuepress/dist/assets/js/65.c59be25f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{537:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),e._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[e._v("#")]),e._v(" Prefix")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Prefix")]),e._v(": "),r("em",[r("code",[e._v("0")]),e._v(" | "),r("code",[e._v("1")]),e._v(" | "),r("code",[e._v("3")]),e._v(" | "),r("code",[e._v("42")]),e._v(" | "),r("code",[e._v("43")]),e._v(" | "),r("code",[e._v("68")]),e._v(" | "),r("code",[e._v("69")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/types.ts:5"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{537:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),e._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[e._v("#")]),e._v(" Prefix")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Prefix")]),e._v(": "),r("em",[r("code",[e._v("0")]),e._v(" | "),r("code",[e._v("1")]),e._v(" | "),r("code",[e._v("3")]),e._v(" | "),r("code",[e._v("42")]),e._v(" | "),r("code",[e._v("43")]),e._v(" | "),r("code",[e._v("68")]),e._v(" | "),r("code",[e._v("69")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/types.ts:5"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/66.486bdb1d.js b/docs/.vuepress/dist/assets/js/66.d89c854d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/66.486bdb1d.js rename to docs/.vuepress/dist/assets/js/66.d89c854d.js index a97b4ff8f..71f538c0d 100644 --- a/docs/.vuepress/dist/assets/js/66.486bdb1d.js +++ b/docs/.vuepress/dist/assets/js/66.d89c854d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{536:function(e,t,r){"use strict";r.r(t);var d=r(46),n=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", _encrypted?: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v("): "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/decode.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/decode.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _encrypted")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{536:function(e,t,r){"use strict";r.r(t);var d=r(46),n=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", _encrypted?: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v("): "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/decode.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/decode.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _encrypted")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/68.fbd534c2.js b/docs/.vuepress/dist/assets/js/68.cc747b6b.js similarity index 92% rename from docs/.vuepress/dist/assets/js/68.fbd534c2.js rename to docs/.vuepress/dist/assets/js/68.cc747b6b.js index fbcd25abf..bf6004fc9 100644 --- a/docs/.vuepress/dist/assets/js/68.fbd534c2.js +++ b/docs/.vuepress/dist/assets/js/68.cc747b6b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{531:function(e,t,r){"use strict";r.r(t);var n=r(46),a=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(__namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v(", passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/encode.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/encode.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{533:function(e,t,r){"use strict";r.r(t);var n=r(46),a=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(__namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v(", passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/encode.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/encode.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/69.9576630c.js b/docs/.vuepress/dist/assets/js/69.a0aca143.js similarity index 90% rename from docs/.vuepress/dist/assets/js/69.9576630c.js rename to docs/.vuepress/dist/assets/js/69.a0aca143.js index 29f324f7f..ed16899fe 100644 --- a/docs/.vuepress/dist/assets/js/69.9576630c.js +++ b/docs/.vuepress/dist/assets/js/69.a0aca143.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{533:function(t,r,e){"use strict";e.r(r);var n=e(46),a=Object(n.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"everybody"}})]),t._v(" "),e("h2",{attrs:{id:"everybody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#everybody","aria-hidden":"true"}},[t._v("#")]),t._v(" everybody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("everybody")]),t._v("(): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/nobody.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/nobody.ts:25"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{531:function(t,r,e){"use strict";e.r(r);var n=e(46),a=Object(n.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"everybody"}})]),t._v(" "),e("h2",{attrs:{id:"everybody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#everybody","aria-hidden":"true"}},[t._v("#")]),t._v(" everybody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("everybody")]),t._v("(): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/nobody.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/nobody.ts:25"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/70.761663d6.js b/docs/.vuepress/dist/assets/js/70.6aa525bb.js similarity index 97% rename from docs/.vuepress/dist/assets/js/70.761663d6.js rename to docs/.vuepress/dist/assets/js/70.6aa525bb.js index 9b02074f0..b01865e02 100644 --- a/docs/.vuepress/dist/assets/js/70.761663d6.js +++ b/docs/.vuepress/dist/assets/js/70.6aa525bb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{530:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v(", __namedParameters: "),r("em",[r("code",[t._v("object")])]),t._v(", encoded: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", isEncrypted: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/toJson.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/toJson.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("tr",[r("td",[t._v("__namedParameters")]),t._v(" "),r("td",[r("code",[t._v("object")])])]),t._v(" "),r("tr",[r("td",[t._v("encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("isEncrypted")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{530:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v(", __namedParameters: "),r("em",[r("code",[t._v("object")])]),t._v(", encoded: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", isEncrypted: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/toJson.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/toJson.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("tr",[r("td",[t._v("__namedParameters")]),t._v(" "),r("td",[r("code",[t._v("object")])])]),t._v(" "),r("tr",[r("td",[t._v("encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("isEncrypted")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/71.8581a9ce.js b/docs/.vuepress/dist/assets/js/71.83d894e0.js similarity index 94% rename from docs/.vuepress/dist/assets/js/71.8581a9ce.js rename to docs/.vuepress/dist/assets/js/71.83d894e0.js index 4f97e9aa0..aa64ee164 100644 --- a/docs/.vuepress/dist/assets/js/71.8581a9ce.js +++ b/docs/.vuepress/dist/assets/js/71.83d894e0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{528:function(t,a,e){"use strict";e.r(a);var r=e(46),s=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("p",[e("a",{attrs:{id:"pairinfo"}})]),t._v(" "),e("h2",{attrs:{id:"pairinfo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pairinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" PairInfo")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ PairInfo")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/types.ts:5"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{528:function(t,a,e){"use strict";e.r(a);var r=e(46),s=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("p",[e("a",{attrs:{id:"pairinfo"}})]),t._v(" "),e("h2",{attrs:{id:"pairinfo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pairinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" PairInfo")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ PairInfo")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/types.ts:5"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/73.bd1cfd69.js b/docs/.vuepress/dist/assets/js/73.89cc551f.js similarity index 97% rename from docs/.vuepress/dist/assets/js/73.bd1cfd69.js rename to docs/.vuepress/dist/assets/js/73.89cc551f.js index 2c19f3698..2b0ca8212 100644 --- a/docs/.vuepress/dist/assets/js/73.bd1cfd69.js +++ b/docs/.vuepress/dist/assets/js/73.89cc551f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{525:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"testkeyring"}})]),t._v(" "),n("h2",{attrs:{id:"testkeyring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#testkeyring","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyring")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("testKeyring")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/testing.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("testing.ts:41"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": testKeyring")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Create an instance of Keyring pre-populated with locked test accounts")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": 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.")]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{525:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"testkeyring"}})]),t._v(" "),n("h2",{attrs:{id:"testkeyring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#testkeyring","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyring")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("testKeyring")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testing.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("testing.ts:41"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": testKeyring")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Create an instance of Keyring pre-populated with locked test accounts")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": 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.")]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/74.faf6749a.js b/docs/.vuepress/dist/assets/js/74.0d118f78.js similarity index 96% rename from docs/.vuepress/dist/assets/js/74.faf6749a.js rename to docs/.vuepress/dist/assets/js/74.0d118f78.js index 574af6213..3569cbca2 100644 --- a/docs/.vuepress/dist/assets/js/74.faf6749a.js +++ b/docs/.vuepress/dist/assets/js/74.0d118f78.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{524:function(t,e,r){"use strict";r.r(e);var s=r(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"testkeyringpairs"}})]),t._v(" "),r("h2",{attrs:{id:"testkeyringpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#testkeyringpairs","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyringPairs")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("testKeyringPairs")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/testingPairs.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("testingPairs.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{524:function(t,e,r){"use strict";r.r(e);var s=r(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"testkeyringpairs"}})]),t._v(" "),r("h2",{attrs:{id:"testkeyringpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#testkeyringpairs","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyringPairs")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("testKeyringPairs")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testingPairs.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("testingPairs.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/75.7610a31e.js b/docs/.vuepress/dist/assets/js/75.11553212.js similarity index 93% rename from docs/.vuepress/dist/assets/js/75.7610a31e.js rename to docs/.vuepress/dist/assets/js/75.11553212.js index a502b6f7c..296c4c983 100644 --- a/docs/.vuepress/dist/assets/js/75.7610a31e.js +++ b/docs/.vuepress/dist/assets/js/75.11553212.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{522:function(e,r,t){"use strict";t.r(r);var a=t(46),i=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[e._v("KeyringInstance")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[e._v("KeyringPair")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[e._v("KeyringPairs")])],1)]),e._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[e._v("KeyringPair$Json")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonencoding"}},[e._v("KeyringPair$JsonEncoding")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonversion"}},[e._v("KeyringPair$JsonVersion")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[e._v("KeyringPair$Meta")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[e._v("KeyringPairType")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"keyringoptions"}})]),e._v(" "),t("h2",{attrs:{id:"keyringoptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringoptions","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringOptions")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringOptions")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:9"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_json"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-json"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-json","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Json")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Json")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:26"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonencoding"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonencoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonencoding","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonEncoding")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonEncoding")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonversion"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonversion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonversion","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonVersion")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonVersion")]),e._v(": "),t("em",[e._v('"0" | "1"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_meta"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-meta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-meta","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Meta")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Meta")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpairtype"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpairtype"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpairtype","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPairType")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPairType")]),e._v(": "),t("em",[e._v('"ed25519" | "sr25519"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:7"),t("OutboundLink")],1)])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{522:function(e,r,t){"use strict";t.r(r);var a=t(46),i=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[e._v("KeyringInstance")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[e._v("KeyringPair")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[e._v("KeyringPairs")])],1)]),e._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[e._v("KeyringPair$Json")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonencoding"}},[e._v("KeyringPair$JsonEncoding")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonversion"}},[e._v("KeyringPair$JsonVersion")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[e._v("KeyringPair$Meta")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[e._v("KeyringPairType")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"keyringoptions"}})]),e._v(" "),t("h2",{attrs:{id:"keyringoptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringoptions","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringOptions")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringOptions")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:9"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_json"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-json"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-json","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Json")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Json")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:26"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonencoding"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonencoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonencoding","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonEncoding")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonEncoding")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonversion"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonversion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonversion","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonVersion")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonVersion")]),e._v(": "),t("em",[e._v('"0" | "1"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_meta"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-meta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-meta","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Meta")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Meta")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpairtype"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpairtype"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpairtype","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPairType")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPairType")]),e._v(": "),t("em",[e._v('"ed25519" | "sr25519"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:7"),t("OutboundLink")],1)])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/79.6353f055.js b/docs/.vuepress/dist/assets/js/79.71ce2c6c.js similarity index 96% rename from docs/.vuepress/dist/assets/js/79.6353f055.js rename to docs/.vuepress/dist/assets/js/79.71ce2c6c.js index e7f69336a..d192e93eb 100644 --- a/docs/.vuepress/dist/assets/js/79.6353f055.js +++ b/docs/.vuepress/dist/assets/js/79.71ce2c6c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{516:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ExtensionHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ExtensionHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{516:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ExtensionHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ExtensionHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/80.f0ffffc2.js b/docs/.vuepress/dist/assets/js/80.c2f44ca3.js similarity index 96% rename from docs/.vuepress/dist/assets/js/80.f0ffffc2.js rename to docs/.vuepress/dist/assets/js/80.c2f44ca3.js index 627768786..8421a30e5 100644 --- a/docs/.vuepress/dist/assets/js/80.f0ffffc2.js +++ b/docs/.vuepress/dist/assets/js/80.c2f44ca3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[80],{515:function(e,r,t){"use strict";t.r(r);var a=t(46),o=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("p",[t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),t("p",[t("strong",[e._v("↳ LeafHeader")])]),e._v(" "),t("h1",{attrs:{id:"constructors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),t("p",[t("a",{attrs:{id:"constructor"}})]),e._v(" "),t("h2",{attrs:{id:"constructor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),t("p",[e._v("⊕ "),t("strong",[e._v("new LeafHeader")]),e._v("(input: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("input")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),t("p",[t("a",{attrs:{id:"tonumber"}})]),e._v(" "),t("h2",{attrs:{id:"tonumber"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("toNumber")]),e._v("(): "),t("code",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("number")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[80],{515:function(e,r,t){"use strict";t.r(r);var a=t(46),o=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("p",[t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),t("p",[t("strong",[e._v("↳ LeafHeader")])]),e._v(" "),t("h1",{attrs:{id:"constructors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),t("p",[t("a",{attrs:{id:"constructor"}})]),e._v(" "),t("h2",{attrs:{id:"constructor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),t("p",[e._v("⊕ "),t("strong",[e._v("new LeafHeader")]),e._v("(input: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("input")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),t("p",[t("a",{attrs:{id:"tonumber"}})]),e._v(" "),t("h2",{attrs:{id:"tonumber"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("toNumber")]),e._v("(): "),t("code",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("number")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/81.67150d18.js b/docs/.vuepress/dist/assets/js/81.8a7a630b.js similarity index 95% rename from docs/.vuepress/dist/assets/js/81.67150d18.js rename to docs/.vuepress/dist/assets/js/81.8a7a630b.js index cf8a836fb..e0dfe2f09 100644 --- a/docs/.vuepress/dist/assets/js/81.67150d18.js +++ b/docs/.vuepress/dist/assets/js/81.8a7a630b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[81],{513:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NibbleHeader")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NibbleHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[81],{513:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NibbleHeader")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NibbleHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/82.c7b1e626.js b/docs/.vuepress/dist/assets/js/82.63a91c1f.js similarity index 94% rename from docs/.vuepress/dist/assets/js/82.c7b1e626.js rename to docs/.vuepress/dist/assets/js/82.63a91c1f.js index 9ab72ad61..24299916b 100644 --- a/docs/.vuepress/dist/assets/js/82.c7b1e626.js +++ b/docs/.vuepress/dist/assets/js/82.63a91c1f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{512:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NodeHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NodeHeader")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:92"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodetype"}})]),e._v(" "),r("h2",{attrs:{id:"nodetype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" nodeType")]),e._v(" "),r("p",[r("strong",[e._v("get nodeType")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L118",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:118"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{512:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NodeHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NodeHeader")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:92"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodetype"}})]),e._v(" "),r("h2",{attrs:{id:"nodetype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" nodeType")]),e._v(" "),r("p",[r("strong",[e._v("get nodeType")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L118",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:118"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/83.e187b60d.js b/docs/.vuepress/dist/assets/js/83.ce3a21bb.js similarity index 87% rename from docs/.vuepress/dist/assets/js/83.e187b60d.js rename to docs/.vuepress/dist/assets/js/83.ce3a21bb.js index 650f113f6..881e37e37 100644 --- a/docs/.vuepress/dist/assets/js/83.e187b60d.js +++ b/docs/.vuepress/dist/assets/js/83.ce3a21bb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{510:function(t,r,s){"use strict";s.r(r);var e=s(46),a=Object(e.a)({},function(){var t=this.$createElement,r=this._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[this._v("#")]),this._v(" Hierarchy")]),this._v(" "),r("p",[r("strong",[this._v("Null")])])])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{509:function(t,r,s){"use strict";s.r(r);var e=s(46),a=Object(e.a)({},function(){var t=this.$createElement,r=this._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[this._v("#")]),this._v(" Hierarchy")]),this._v(" "),r("p",[r("strong",[this._v("Null")])])])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/84.25b906a0.js b/docs/.vuepress/dist/assets/js/84.30cc8514.js similarity index 88% rename from docs/.vuepress/dist/assets/js/84.25b906a0.js rename to docs/.vuepress/dist/assets/js/84.30cc8514.js index 539c6efdd..97a4c75c6 100644 --- a/docs/.vuepress/dist/assets/js/84.25b906a0.js +++ b/docs/.vuepress/dist/assets/js/84.30cc8514.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{509:function(t,e,n){"use strict";n.r(e);var o=n(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"variables"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_no_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-no-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-no-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_NO_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_NO_VALUE")]),t._v(": "),n("em",[n("code",[t._v("254")])]),t._v(" = 254")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:10"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_with_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-with-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-with-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_WITH_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_WITH_VALUE")]),t._v(": "),n("em",[n("code",[t._v("255")])]),t._v(" = 255")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty_trie"}})]),t._v(" "),n("h2",{attrs:{id:"const-empty-trie"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-empty-trie","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EMPTY_TRIE")]),t._v(" "),n("p",[n("strong",[t._v("● EMPTY_TRIE")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:5"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("253")])]),t._v(" = 253")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("128")])]),t._v(" = 128")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:8"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:15"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("127")])]),t._v(" = 127")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:7"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:6"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:12"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_branch"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-branch"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-branch","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_BRANCH")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_BRANCH")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:17"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_ext"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-ext"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-ext","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_EXT")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_EXT")]),t._v(": "),n("em",[n("code",[t._v("2")])]),t._v(" = 2")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:18"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_leaf"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-leaf"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_LEAF")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_LEAF")]),t._v(": "),n("em",[n("code",[t._v("3")])]),t._v(" = 3")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_null"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-null"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-null","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_NULL")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_NULL")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:16"),n("OutboundLink")],1)])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{510:function(t,e,n){"use strict";n.r(e);var o=n(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"variables"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_no_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-no-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-no-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_NO_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_NO_VALUE")]),t._v(": "),n("em",[n("code",[t._v("254")])]),t._v(" = 254")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:10"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_with_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-with-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-with-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_WITH_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_WITH_VALUE")]),t._v(": "),n("em",[n("code",[t._v("255")])]),t._v(" = 255")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty_trie"}})]),t._v(" "),n("h2",{attrs:{id:"const-empty-trie"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-empty-trie","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EMPTY_TRIE")]),t._v(" "),n("p",[n("strong",[t._v("● EMPTY_TRIE")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:5"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("253")])]),t._v(" = 253")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("128")])]),t._v(" = 128")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:8"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:15"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("127")])]),t._v(" = 127")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:7"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:6"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:12"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_branch"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-branch"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-branch","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_BRANCH")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_BRANCH")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:17"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_ext"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-ext"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-ext","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_EXT")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_EXT")]),t._v(": "),n("em",[n("code",[t._v("2")])]),t._v(" = 2")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:18"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_leaf"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-leaf"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_LEAF")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_LEAF")]),t._v(": "),n("em",[n("code",[t._v("3")])]),t._v(" = 3")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_null"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-null"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-null","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_NULL")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_NULL")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:16"),n("OutboundLink")],1)])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/85.7eec7fe1.js b/docs/.vuepress/dist/assets/js/85.d1539fa0.js similarity index 96% rename from docs/.vuepress/dist/assets/js/85.7eec7fe1.js rename to docs/.vuepress/dist/assets/js/85.d1539fa0.js index e9e918fa2..4cde3a64b 100644 --- a/docs/.vuepress/dist/assets/js/85.7eec7fe1.js +++ b/docs/.vuepress/dist/assets/js/85.d1539fa0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{507:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(input: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/decode.ts#L95",target:"_blank",rel:"noopener noreferrer"}},[e._v("decode.ts:95"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{507:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(input: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/decode.ts#L95",target:"_blank",rel:"noopener noreferrer"}},[e._v("decode.ts:95"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/86.ca4aeb94.js b/docs/.vuepress/dist/assets/js/86.bf1809e4.js similarity index 96% rename from docs/.vuepress/dist/assets/js/86.ca4aeb94.js rename to docs/.vuepress/dist/assets/js/86.bf1809e4.js index ebb3a341d..641b8aa35 100644 --- a/docs/.vuepress/dist/assets/js/86.ca4aeb94.js +++ b/docs/.vuepress/dist/assets/js/86.bf1809e4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[86],{506:function(e,t,r){"use strict";r.r(t);var n=r(46),o=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/encode.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("encode.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[86],{506:function(e,t,r){"use strict";r.r(t);var n=r(46),o=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/encode.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("encode.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/88.b93f0896.js b/docs/.vuepress/dist/assets/js/88.de0b3335.js similarity index 94% rename from docs/.vuepress/dist/assets/js/88.b93f0896.js rename to docs/.vuepress/dist/assets/js/88.de0b3335.js index a1788e88c..b06a9c58b 100644 --- a/docs/.vuepress/dist/assets/js/88.b93f0896.js +++ b/docs/.vuepress/dist/assets/js/88.de0b3335.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[88],{503:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"addnibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"addnibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addnibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" addNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("addNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:31"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"decodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNibbles")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"encodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeNibbles")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:65"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractkey"}})]),e._v(" "),r("h2",{attrs:{id:"extractkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractkey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractKey")]),e._v("(key: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractnodekey"}})]),e._v(" "),r("h2",{attrs:{id:"extractnodekey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractnodekey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractNodeKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractNodeKey")]),e._v("(__namedParameters: "),r("em",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnibblesterminated"}})]),e._v(" "),r("h2",{attrs:{id:"isnibblesterminated"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnibblesterminated","aria-hidden":"true"}},[e._v("#")]),e._v(" isNibblesTerminated")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isNibblesTerminated")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"removenibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"removenibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#removenibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" removeNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("removeNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[88],{503:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"addnibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"addnibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addnibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" addNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("addNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:31"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"decodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNibbles")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"encodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeNibbles")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:65"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractkey"}})]),e._v(" "),r("h2",{attrs:{id:"extractkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractkey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractKey")]),e._v("(key: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractnodekey"}})]),e._v(" "),r("h2",{attrs:{id:"extractnodekey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractnodekey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractNodeKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractNodeKey")]),e._v("(__namedParameters: "),r("em",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnibblesterminated"}})]),e._v(" "),r("h2",{attrs:{id:"isnibblesterminated"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnibblesterminated","aria-hidden":"true"}},[e._v("#")]),e._v(" isNibblesTerminated")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isNibblesTerminated")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"removenibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"removenibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#removenibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" removeNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("removeNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/90.f647d951.js b/docs/.vuepress/dist/assets/js/90.fc751a64.js similarity index 96% rename from docs/.vuepress/dist/assets/js/90.f647d951.js rename to docs/.vuepress/dist/assets/js/90.fc751a64.js index f6b2a8842..021be2364 100644 --- a/docs/.vuepress/dist/assets/js/90.f647d951.js +++ b/docs/.vuepress/dist/assets/js/90.fc751a64.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{500:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createbranch"}})]),t._v(" "),r("h2",{attrs:{id:"createbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" createBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", hasChildren: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createBranch.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createBranch.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("hasChildren")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{500:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createbranch"}})]),t._v(" "),r("h2",{attrs:{id:"createbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" createBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", hasChildren: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createBranch.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createBranch.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("hasChildren")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/91.90790685.js b/docs/.vuepress/dist/assets/js/91.9a0c0b54.js similarity index 94% rename from docs/.vuepress/dist/assets/js/91.90790685.js rename to docs/.vuepress/dist/assets/js/91.9a0c0b54.js index a40f8d23a..02297661e 100644 --- a/docs/.vuepress/dist/assets/js/91.90790685.js +++ b/docs/.vuepress/dist/assets/js/91.9a0c0b54.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[91],{498:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createempty"}})]),t._v(" "),r("h2",{attrs:{id:"createempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createempty","aria-hidden":"true"}},[t._v("#")]),t._v(" createEmpty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createEmpty")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createEmpty.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createEmpty.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[91],{498:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createempty"}})]),t._v(" "),r("h2",{attrs:{id:"createempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createempty","aria-hidden":"true"}},[t._v("#")]),t._v(" createEmpty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createEmpty")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createEmpty.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createEmpty.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/92.0232558c.js b/docs/.vuepress/dist/assets/js/92.f45b658c.js similarity index 95% rename from docs/.vuepress/dist/assets/js/92.0232558c.js rename to docs/.vuepress/dist/assets/js/92.f45b658c.js index 4caf7fdca..0d25e574f 100644 --- a/docs/.vuepress/dist/assets/js/92.0232558c.js +++ b/docs/.vuepress/dist/assets/js/92.f45b658c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[92],{497:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createextension"}})]),t._v(" "),r("h2",{attrs:{id:"createextension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createextension","aria-hidden":"true"}},[t._v("#")]),t._v(" createExtension")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createExtension")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createExtension.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createExtension.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[92],{497:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createextension"}})]),t._v(" "),r("h2",{attrs:{id:"createextension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createextension","aria-hidden":"true"}},[t._v("#")]),t._v(" createExtension")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createExtension")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createExtension.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createExtension.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/93.5fee3d34.js b/docs/.vuepress/dist/assets/js/93.4228fc8d.js similarity index 92% rename from docs/.vuepress/dist/assets/js/93.5fee3d34.js rename to docs/.vuepress/dist/assets/js/93.4228fc8d.js index de0fd887a..431bac1d2 100644 --- a/docs/.vuepress/dist/assets/js/93.5fee3d34.js +++ b/docs/.vuepress/dist/assets/js/93.4228fc8d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[93],{495:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createleaf"}})]),t._v(" "),r("h2",{attrs:{id:"createleaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createleaf","aria-hidden":"true"}},[t._v("#")]),t._v(" createLeaf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createLeaf")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createLeaf.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createLeaf.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[93],{495:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createleaf"}})]),t._v(" "),r("h2",{attrs:{id:"createleaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createleaf","aria-hidden":"true"}},[t._v("#")]),t._v(" createLeaf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createLeaf")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createLeaf.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createLeaf.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/94.2a21fa79.js b/docs/.vuepress/dist/assets/js/94.6d5a907e.js similarity index 95% rename from docs/.vuepress/dist/assets/js/94.2a21fa79.js rename to docs/.vuepress/dist/assets/js/94.6d5a907e.js index 2536d9fba..1f1cdb3fd 100644 --- a/docs/.vuepress/dist/assets/js/94.2a21fa79.js +++ b/docs/.vuepress/dist/assets/js/94.6d5a907e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[94],{494:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createsubstream"}})]),t._v(" "),r("h2",{attrs:{id:"createsubstream"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createsubstream","aria-hidden":"true"}},[t._v("#")]),t._v(" createSubstream")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createSubstream")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createSubstream.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createSubstream.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[94],{494:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createsubstream"}})]),t._v(" "),r("h2",{attrs:{id:"createsubstream"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createsubstream","aria-hidden":"true"}},[t._v("#")]),t._v(" createSubstream")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createSubstream")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createSubstream.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createSubstream.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/95.3b9ee325.js b/docs/.vuepress/dist/assets/js/95.8c661080.js similarity index 95% rename from docs/.vuepress/dist/assets/js/95.3b9ee325.js rename to docs/.vuepress/dist/assets/js/95.8c661080.js index 6b885265b..65359b19f 100644 --- a/docs/.vuepress/dist/assets/js/95.3b9ee325.js +++ b/docs/.vuepress/dist/assets/js/95.8c661080.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[95],{492:function(e,t,r){"use strict";r.r(t);var a=r(46),n=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"createvalue"}})]),e._v(" "),r("h2",{attrs:{id:"createvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createvalue","aria-hidden":"true"}},[e._v("#")]),e._v(" createValue")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createValue")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createValue.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("stream/createValue.ts:9"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[95],{492:function(e,t,r){"use strict";r.r(t);var a=r(46),n=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"createvalue"}})]),e._v(" "),r("h2",{attrs:{id:"createvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createvalue","aria-hidden":"true"}},[e._v("#")]),e._v(" createValue")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createValue")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createValue.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("stream/createValue.ts:9"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/96.3ae6747c.js b/docs/.vuepress/dist/assets/js/96.be58a66c.js similarity index 91% rename from docs/.vuepress/dist/assets/js/96.3ae6747c.js rename to docs/.vuepress/dist/assets/js/96.be58a66c.js index 7e4196d3c..6ae63de34 100644 --- a/docs/.vuepress/dist/assets/js/96.3ae6747c.js +++ b/docs/.vuepress/dist/assets/js/96.be58a66c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[96],{489:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encbranch"}})]),t._v(" "),r("h2",{attrs:{id:"encbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" encBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/endBranch.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/endBranch.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[96],{491:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encbranch"}})]),t._v(" "),r("h2",{attrs:{id:"encbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" encBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/endBranch.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/endBranch.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/97.23a987d0.js b/docs/.vuepress/dist/assets/js/97.7606a016.js similarity index 89% rename from docs/.vuepress/dist/assets/js/97.23a987d0.js rename to docs/.vuepress/dist/assets/js/97.7606a016.js index 6ec26f779..b147d6b0e 100644 --- a/docs/.vuepress/dist/assets/js/97.23a987d0.js +++ b/docs/.vuepress/dist/assets/js/97.7606a016.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{491:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"codec"}})]),e._v(" "),a("h2",{attrs:{id:"codec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codec","aria-hidden":"true"}},[e._v("#")]),e._v(" Codec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Codec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{489:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"codec"}})]),e._v(" "),a("h2",{attrs:{id:"codec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codec","aria-hidden":"true"}},[e._v("#")]),e._v(" Codec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Codec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/98.9f18e37a.js b/docs/.vuepress/dist/assets/js/98.a559845e.js similarity index 98% rename from docs/.vuepress/dist/assets/js/98.9f18e37a.js rename to docs/.vuepress/dist/assets/js/98.a559845e.js index 425e05a37..7e7bde2df 100644 --- a/docs/.vuepress/dist/assets/js/98.9f18e37a.js +++ b/docs/.vuepress/dist/assets/js/98.a559845e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{488:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"fromnibbles"}})]),t._v(" "),a("h2",{attrs:{id:"fromnibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fromnibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" fromNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("fromNibbles")]),t._v("(input: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/fromNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/fromNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": fromNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" fromNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("fromNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x41, 0x20]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{488:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"fromnibbles"}})]),t._v(" "),a("h2",{attrs:{id:"fromnibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fromnibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" fromNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("fromNibbles")]),t._v("(input: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fromNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/fromNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": fromNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" fromNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("fromNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x41, 0x20]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/99.5fee1c3a.js b/docs/.vuepress/dist/assets/js/99.c6bdd4ab.js similarity index 96% rename from docs/.vuepress/dist/assets/js/99.5fee1c3a.js rename to docs/.vuepress/dist/assets/js/99.c6bdd4ab.js index f56750cd2..61242c947 100644 --- a/docs/.vuepress/dist/assets/js/99.5fee1c3a.js +++ b/docs/.vuepress/dist/assets/js/99.c6bdd4ab.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{486:function(e,t,s){"use strict";s.r(t);var r=s(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),s("p",[s("a",{attrs:{id:"fusenibbles"}})]),e._v(" "),s("h2",{attrs:{id:"fusenibbles"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#fusenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" fuseNibbles")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("fuseNibbles")]),e._v("(nibbles: "),s("em",[s("code",[e._v("Uint8Array")])]),e._v(", isLeaf: "),s("em",[s("code",[e._v("boolean")])]),e._v("): "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/fuseNibbles.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/fuseNibbles.ts:12"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[e._v("nibbles")]),e._v(" "),s("td",[s("code",[e._v("Uint8Array")])])]),e._v(" "),s("tr",[s("td",[e._v("isLeaf")]),e._v(" "),s("td",[s("code",[e._v("boolean")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{486:function(e,t,s){"use strict";s.r(t);var r=s(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),s("p",[s("a",{attrs:{id:"fusenibbles"}})]),e._v(" "),s("h2",{attrs:{id:"fusenibbles"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#fusenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" fuseNibbles")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("fuseNibbles")]),e._v("(nibbles: "),s("em",[s("code",[e._v("Uint8Array")])]),e._v(", isLeaf: "),s("em",[s("code",[e._v("boolean")])]),e._v("): "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fuseNibbles.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/fuseNibbles.ts:12"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[e._v("nibbles")]),e._v(" "),s("td",[s("code",[e._v("Uint8Array")])])]),e._v(" "),s("tr",[s("td",[e._v("isLeaf")]),e._v(" "),s("td",[s("code",[e._v("boolean")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/app.5fce000e.js b/docs/.vuepress/dist/assets/js/app.1af07c41.js similarity index 71% rename from docs/.vuepress/dist/assets/js/app.5fce000e.js rename to docs/.vuepress/dist/assets/js/app.1af07c41.js index 47a55e7e6..28676bd94 100644 --- a/docs/.vuepress/dist/assets/js/app.5fce000e.js +++ b/docs/.vuepress/dist/assets/js/app.1af07c41.js @@ -1,8 +1,8 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(e){function t(t){for(var r,i,l=t[0],s=t[1],u=t[2],d=0,f=[];d0?o(r(e),9007199254740991):0}},function(e,t){var n=e.exports={version:"2.6.5"};"number"==typeof __e&&(__e=n)},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(67);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){var r=n(11),o=n(136),a=n(137),i=Object.defineProperty;t.f=n(21)?Object.defineProperty:function(e,t,n){if(r(e),t=a(t,!0),r(n),o)try{return i(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported!");return"value"in n&&(e[t]=n.value),e}},function(e,t,n){var r=n(5),o=n(17),a=n(48),i=n(71)("src"),l=n(150),s=(""+l).split("toString");n(23).inspectSource=function(e){return l.call(e)},(e.exports=function(e,t,n,l){var u="function"==typeof n;u&&(a(n,"name")||o(n,"name",t)),e[t]!==n&&(u&&(a(n,i)||o(n,i,e[t]?""+e[t]:s.join(String(t)))),e===r?e[t]=n:l?e[t]?e[t]=n:o(e,t,n):(delete e[t],o(e,t,n)))})(Function.prototype,"toString",function(){return"function"==typeof this&&this[i]||l.call(this)})},function(e,t,n){var r=n(33);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,n){var r=n(28);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,n){var r=n(108),o=n(83);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t){e.exports=!0},function(e,t,n){"use strict";var r=n(195)(!0);n(88)(String,"String",function(e){this._t=String(e),this._i=0},function(){var e,t=this._t,n=this._i;return n>=t.length?{value:void 0,done:!0}:(e=r(t,n),this._i+=e.length,{value:e,done:!1})})},function(e,t,n){var r=n(7).f,o=n(18),a=n(4)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,a)&&r(e,a,{configurable:!0,value:t})}},function(e,t,n){var r=n(12),o=n(115),a=n(116),i=n(9),l=n(51),s=n(117),u={},c={};(t=e.exports=function(e,t,n,d,f){var h,p,m,v,_=f?function(){return e}:s(e),y=r(n,d,t?2:1),b=0;if("function"!=typeof _)throw TypeError(e+" is not iterable!");if(a(_)){for(h=l(e.length);h>b;b++)if((v=t?y(i(p=e[b])[0],p[1]):y(e[b]))===u||v===c)return v}else for(m=_.call(e);!(p=m.next()).done;)if((v=o(m,y,p.value,t))===u||v===c)return v}).BREAK=u,t.RETURN=c},function(e,t,n){e.exports=n(185)},function(e,t,n){e.exports=n(189)},function(e,t,n){e.exports=n(213)},function(e,t,n){"use strict";function r(e,t,n,r,o,a,i,l){var s,u="function"==typeof e?e.options:e;if(t&&(u.render=t,u.staticRenderFns=n,u._compiled=!0),r&&(u.functional=!0),a&&(u._scopeId="data-v-"+a),i?(s=function(e){(e=e||this.$vnode&&this.$vnode.ssrContext||this.parent&&this.parent.$vnode&&this.parent.$vnode.ssrContext)||"undefined"==typeof __VUE_SSR_CONTEXT__||(e=__VUE_SSR_CONTEXT__),o&&o.call(this,e),e&&e._registeredComponents&&e._registeredComponents.add(i)},u._ssrRegister=s):o&&(s=l?function(){o.call(this,this.$root.$options.shadowRoot)}:o),s)if(u.functional){u._injectStyles=s;var c=u.render;u.render=function(e,t){return s.call(t),c(e,t)}}else{var d=u.beforeCreate;u.beforeCreate=d?[].concat(d,s):[s]}return{exports:e,options:u}}n.d(t,"a",function(){return r})},function(e,t,n){"use strict";var r=n(27);e.exports=function(e,t){return!!e&&r(function(){t?e.call(null,function(){},1):e.call(null)})}},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t,n){var r=n(24);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){var r=n(80),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,n){for(var r=n(100),o=n(73),a=n(30),i=n(5),l=n(17),s=n(32),u=n(2),c=u("iterator"),d=u("toStringTag"),f=s.Array,h={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},p=o(h),m=0;mdocument.F=Object<\/script>"),e.close(),s=e.F;r--;)delete s.prototype[a[r]];return s()};e.exports=Object.create||function(e,t){var n;return null!==e?(l.prototype=r(e),n=new l,l.prototype=null,n[i]=e):n=s(),void 0===t?n:o(n,t)}},function(e,t,n){n(198);for(var r=n(3),o=n(14),a=n(26),i=n(4)("toStringTag"),l="CSSRuleList,CSSStyleDeclaration,CSSValueList,ClientRectList,DOMRectList,DOMStringList,DOMTokenList,DataTransferItemList,FileList,HTMLAllCollection,HTMLCollection,HTMLFormElement,HTMLSelectElement,MediaList,MimeTypeArray,NamedNodeMap,NodeList,PaintRequestList,Plugin,PluginArray,SVGLengthList,SVGNumberList,SVGPathSegList,SVGPointList,SVGStringList,SVGTransformList,SourceBufferList,StyleSheetList,TextTrackCueList,TextTrackList,TouchList".split(","),s=0;s0?o(r(e),9007199254740991):0}},function(e,t){var n=e.exports={version:"2.6.5"};"number"==typeof __e&&(__e=n)},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(67);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){var r=n(11),o=n(136),a=n(137),i=Object.defineProperty;t.f=n(21)?Object.defineProperty:function(e,t,n){if(r(e),t=a(t,!0),r(n),o)try{return i(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported!");return"value"in n&&(e[t]=n.value),e}},function(e,t,n){var r=n(5),o=n(17),a=n(48),i=n(71)("src"),l=n(150),s=(""+l).split("toString");n(23).inspectSource=function(e){return l.call(e)},(e.exports=function(e,t,n,l){var u="function"==typeof n;u&&(a(n,"name")||o(n,"name",t)),e[t]!==n&&(u&&(a(n,i)||o(n,i,e[t]?""+e[t]:s.join(String(t)))),e===r?e[t]=n:l?e[t]?e[t]=n:o(e,t,n):(delete e[t],o(e,t,n)))})(Function.prototype,"toString",function(){return"function"==typeof this&&this[i]||l.call(this)})},function(e,t,n){var r=n(33);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,n){var r=n(28);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,n){var r=n(108),o=n(83);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t){e.exports=!0},function(e,t,n){"use strict";var r=n(195)(!0);n(88)(String,"String",function(e){this._t=String(e),this._i=0},function(){var e,t=this._t,n=this._i;return n>=t.length?{value:void 0,done:!0}:(e=r(t,n),this._i+=e.length,{value:e,done:!1})})},function(e,t,n){var r=n(7).f,o=n(18),a=n(4)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,a)&&r(e,a,{configurable:!0,value:t})}},function(e,t,n){var r=n(12),o=n(115),a=n(116),i=n(9),l=n(51),s=n(117),u={},c={};(t=e.exports=function(e,t,n,d,f){var h,p,m,v,_=f?function(){return e}:s(e),y=r(n,d,t?2:1),b=0;if("function"!=typeof _)throw TypeError(e+" is not iterable!");if(a(_)){for(h=l(e.length);h>b;b++)if((v=t?y(i(p=e[b])[0],p[1]):y(e[b]))===u||v===c)return v}else for(m=_.call(e);!(p=m.next()).done;)if((v=o(m,y,p.value,t))===u||v===c)return v}).BREAK=u,t.RETURN=c},function(e,t,n){e.exports=n(185)},function(e,t,n){e.exports=n(189)},function(e,t,n){e.exports=n(213)},function(e,t,n){"use strict";function r(e,t,n,r,o,a,i,l){var s,u="function"==typeof e?e.options:e;if(t&&(u.render=t,u.staticRenderFns=n,u._compiled=!0),r&&(u.functional=!0),a&&(u._scopeId="data-v-"+a),i?(s=function(e){(e=e||this.$vnode&&this.$vnode.ssrContext||this.parent&&this.parent.$vnode&&this.parent.$vnode.ssrContext)||"undefined"==typeof __VUE_SSR_CONTEXT__||(e=__VUE_SSR_CONTEXT__),o&&o.call(this,e),e&&e._registeredComponents&&e._registeredComponents.add(i)},u._ssrRegister=s):o&&(s=l?function(){o.call(this,this.$root.$options.shadowRoot)}:o),s)if(u.functional){u._injectStyles=s;var c=u.render;u.render=function(e,t){return s.call(t),c(e,t)}}else{var d=u.beforeCreate;u.beforeCreate=d?[].concat(d,s):[s]}return{exports:e,options:u}}n.d(t,"a",function(){return r})},function(e,t,n){"use strict";var r=n(27);e.exports=function(e,t){return!!e&&r(function(){t?e.call(null,function(){},1):e.call(null)})}},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t,n){var r=n(24);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){var r=n(80),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,n){for(var r=n(100),o=n(73),a=n(30),i=n(5),l=n(17),s=n(32),u=n(2),c=u("iterator"),d=u("toStringTag"),f=s.Array,h={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},p=o(h),m=0;mdocument.F=Object<\/script>"),e.close(),s=e.F;r--;)delete s.prototype[a[r]];return s()};e.exports=Object.create||function(e,t){var n;return null!==e?(l.prototype=r(e),n=new l,l.prototype=null,n[i]=e):n=s(),void 0===t?n:o(n,t)}},function(e,t,n){n(198);for(var r=n(3),o=n(14),a=n(26),i=n(4)("toStringTag"),l="CSSRuleList,CSSStyleDeclaration,CSSValueList,ClientRectList,DOMRectList,DOMStringList,DOMTokenList,DataTransferItemList,FileList,HTMLAllCollection,HTMLCollection,HTMLFormElement,HTMLSelectElement,MediaList,MimeTypeArray,NamedNodeMap,NodeList,PaintRequestList,Plugin,PluginArray,SVGLengthList,SVGNumberList,SVGPathSegList,SVGPointList,SVGStringList,SVGTransformList,SourceBufferList,StyleSheetList,TextTrackCueList,TextTrackList,TouchList".split(","),s=0;s
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var s=n.render(!t),u=s.querySelector(r.barSelector),c=r.speed,d=r.easing;return s.offsetWidth,i(function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(u,function(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}(e,c,d)),1===e?(l(s,{transition:"none",opacity:1}),s.offsetWidth,setTimeout(function(){l(s,{transition:"all "+c+"ms linear",opacity:0}),setTimeout(function(){n.remove(),t()},c)},c)):setTimeout(t,c)}),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout(function(){n.status&&(n.trickle(),e())},r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always(function(){0==--t?(e=0,n.done()):n.set((e-t)/e)}),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){c(document.documentElement,"nprogress-busy"),c(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var i=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,function(e,t){return t.toUpperCase()}),t[n]||(t[n]=function(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}(n))}function r(e,t,r){t=n(t),e.style[t]=r}return function(e,t){var n,o,a=arguments;if(2==a.length)for(n in t)void 0!==(o=t[n])&&t.hasOwnProperty(n)&&r(e,n,o);else r(e,a[1],a[2])}}();function s(e,t){var n="string"==typeof e?e:d(e);return n.indexOf(" "+t+" ")>=0}function u(e,t){var n=d(e),r=n+t;s(n,t)||(e.className=r.substring(1))}function c(e,t){var n,r=d(e);s(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function d(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n})?r.call(t,n,t,e):r)||(e.exports=o)},function(e,t,n){"use strict";var r=n(8),o=n(66)(1);r(r.P+r.F*!n(47)([].map,!0),"Array",{map:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(49),o=n(28);e.exports=function(e){return r(o(e))}},function(e,t,n){var r=n(31),o=n(49),a=n(34),i=n(22),l=n(172);e.exports=function(e,t){var n=1==e,s=2==e,u=3==e,c=4==e,d=6==e,f=5==e||d,h=t||l;return function(t,l,p){for(var m,v,_=a(t),y=o(_),b=r(l,p,3),g=i(y.length),x=0,k=n?h(t,g):s?h(t,0):void 0;g>x;x++)if((f||x in y)&&(v=b(m=y[x],x,_),e))if(n)k[x]=v;else if(v)switch(e){case 3:return!0;case 5:return m;case 6:return x;case 2:k.push(m)}else if(c)return!1;return d?-1:u||c?c:k}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){"use strict";var r=n(8),o=n(66)(2);r(r.P+r.F*!n(47)([].filter,!0),"Array",{filter:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(23),o=n(5),a=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(e.exports=function(e,t){return a[e]||(a[e]=void 0!==t?t:{})})("versions",[]).push({version:r.version,mode:n(70)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports=!1},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t,n){var r=n(15),o=n(5).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t,n){var r=n(138),o=n(99);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t,n){var r=n(69)("keys"),o=n(71);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){var r=n(29).f,o=n(48),a=n(2)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,a)&&r(e,a,{configurable:!0,value:t})}},function(e,t,n){var r=n(24),o=n(2)("toStringTag"),a="Arguments"==r(function(){return arguments}());e.exports=function(e){var t,n,i;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(n=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),o))?n:a?r(t):"Object"==(i=r(t))&&"function"==typeof t.callee?"Arguments":i}},function(e,t,n){var r=n(6),o=n(3).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t,n){var r=n(6);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},function(e,t,n){var r=n(38);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){var r=n(82)("keys"),o=n(52);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){var r=n(0),o=n(3),a=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(e.exports=function(e,t){return a[e]||(a[e]=void 0!==t?t:{})})("versions",[]).push({version:r.version,mode:n(39)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){"use strict";var r=n(8),o=n(66)(0),a=n(47)([].forEach,!0);r(r.P+r.F*!a,"Array",{forEach:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(1),o=n(0),a=n(16);e.exports=function(e,t){var n=(o.Object||{})[e]||Object[e],i={};i[e]=t(n),r(r.S+r.F*a(function(){n(1)}),"Object",i)}},function(e,t,n){var r=n(108),o=n(83).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return r(e,o)}},function(e,t,n){var r=n(54),o=n(36),a=n(19),i=n(78),l=n(18),s=n(107),u=Object.getOwnPropertyDescriptor;t.f=n(10)?u:function(e,t){if(e=a(e),t=i(t,!0),s)try{return u(e,t)}catch(e){}if(l(e,t))return o(!r.f.call(e,t),e[t])}},function(e,t,n){"use strict";var r=n(39),o=n(1),a=n(111),i=n(14),l=n(26),s=n(196),u=n(41),c=n(109),d=n(4)("iterator"),f=!([].keys&&"next"in[].keys()),h=function(){return this};e.exports=function(e,t,n,p,m,v,_){s(n,t,p);var y,b,g,x=function(e){if(!f&&e in A)return A[e];switch(e){case"keys":case"values":return function(){return new n(this,e)}}return function(){return new n(this,e)}},k=t+" Iterator",E="values"==m,w=!1,A=e.prototype,P=A[d]||A["@@iterator"]||m&&A[m],L=P||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&A.entries||P;if(S&&(g=c(S.call(new e)))!==Object.prototype&&g.next&&(u(g,k,!0),r||"function"==typeof g[d]||i(g,d,h)),E&&P&&"values"!==P.name&&(w=!0,L=function(){return P.call(this)}),r&&!_||!f&&!w&&A[d]||i(A,d,L),l[t]=L,l[k]=h,m)if(y={values:E?L:x("values"),keys:v?L:x("keys"),entries:M},_)for(b in y)b in A||a(A,b,y[b]);else o(o.P+o.F*(f||w),t,y);return y}},function(e,t,n){t.f=n(4)},function(e,t,n){var r=n(3),o=n(0),a=n(39),i=n(89),l=n(7).f;e.exports=function(e){var t=o.Symbol||(o.Symbol=a?{}:r.Symbol||{});"_"==e.charAt(0)||e in t||l(t,e,{value:i.f(e)})}},function(e,t,n){var r=n(38);e.exports=Array.isArray||function(e){return"Array"==r(e)}},function(e,t){},function(e,t){e.exports=function(e,t,n,r){if(!(e instanceof t)||void 0!==r&&r in e)throw TypeError(n+": incorrect invocation!");return e}},function(e,t,n){"use strict";var r=n(35);function o(e){var t,n;this.promise=new e(function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r}),this.resolve=r(t),this.reject=r(n)}e.exports.f=function(e){return new o(e)}},function(e,t,n){var r=n(14);e.exports=function(e,t,n){for(var o in t)n&&e[o]?e[o]=t[o]:r(e,o,t[o]);return e}},function(e,t,n){e.exports=n(194)},function(e,t,n){e.exports=n(221)},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){"use strict";var r=n(148),o=n(149),a=n(32),i=n(65);e.exports=n(101)(Array,"Array",function(e,t){this._t=i(e),this._i=0,this._k=t},function(){var e=this._t,t=this._k,n=this._i++;return!e||n>=e.length?(this._t=void 0,o(1)):o(0,"keys"==t?n:"values"==t?e[n]:[n,e[n]])},"values"),a.Arguments=a.Array,r("keys"),r("values"),r("entries")},function(e,t,n){"use strict";var r=n(70),o=n(8),a=n(30),i=n(17),l=n(32),s=n(151),u=n(75),c=n(155),d=n(2)("iterator"),f=!([].keys&&"next"in[].keys()),h=function(){return this};e.exports=function(e,t,n,p,m,v,_){s(n,t,p);var y,b,g,x=function(e){if(!f&&e in A)return A[e];switch(e){case"keys":case"values":return function(){return new n(this,e)}}return function(){return new n(this,e)}},k=t+" Iterator",E="values"==m,w=!1,A=e.prototype,P=A[d]||A["@@iterator"]||m&&A[m],L=P||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&A.entries||P;if(S&&(g=c(S.call(new e)))!==Object.prototype&&g.next&&(u(g,k,!0),r||"function"==typeof g[d]||i(g,d,h)),E&&P&&"values"!==P.name&&(w=!0,L=function(){return P.call(this)}),r&&!_||!f&&!w&&A[d]||i(A,d,L),l[t]=L,l[k]=h,m)if(y={values:E?L:x("values"),keys:v?L:x("keys"),entries:M},_)for(b in y)b in A||a(A,b,y[b]);else o(o.P+o.F*(f||w),t,y);return y}},function(e,t,n){var r=n(5).document;e.exports=r&&r.documentElement},function(e,t,n){var r=n(11),o=n(33),a=n(2)("species");e.exports=function(e,t){var n,i=r(e).constructor;return void 0===i||null==(n=r(i)[a])?t:o(n)}},function(e,t,n){var r,o,a,i=n(31),l=n(162),s=n(102),u=n(72),c=n(5),d=c.process,f=c.setImmediate,h=c.clearImmediate,p=c.MessageChannel,m=c.Dispatch,v=0,_={},y=function(){var e=+this;if(_.hasOwnProperty(e)){var t=_[e];delete _[e],t()}},b=function(e){y.call(e.data)};f&&h||(f=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return _[++v]=function(){l("function"==typeof e?e:Function(e),t)},r(v),v},h=function(e){delete _[e]},"process"==n(24)(d)?r=function(e){d.nextTick(i(y,e,1))}:m&&m.now?r=function(e){m.now(i(y,e,1))}:p?(a=(o=new p).port2,o.port1.onmessage=b,r=i(a.postMessage,a,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(e){c.postMessage(e+"","*")},c.addEventListener("message",b,!1)):r="onreadystatechange"in u("script")?function(e){s.appendChild(u("script")).onreadystatechange=function(){s.removeChild(this),y.call(e)}}:function(e){setTimeout(i(y,e,1),0)}),e.exports={set:f,clear:h}},function(e,t,n){"use strict";var r=n(33);function o(e){var t,n;this.promise=new e(function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r}),this.resolve=r(t),this.reject=r(n)}e.exports.f=function(e){return new o(e)}},function(e,t,n){var r=n(11),o=n(15),a=n(105);e.exports=function(e,t){if(r(e),o(t)&&t.constructor===e)return t;var n=a.f(e);return(0,n.resolve)(t),n.promise}},function(e,t,n){e.exports=!n(10)&&!n(16)(function(){return 7!=Object.defineProperty(n(77)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(18),o=n(19),a=n(178)(!1),i=n(81)("IE_PROTO");e.exports=function(e,t){var n,l=o(e),s=0,u=[];for(n in l)n!=i&&r(l,n)&&u.push(n);for(;t.length>s;)r(l,n=t[s++])&&(~a(u,n)||u.push(n));return u}},function(e,t,n){var r=n(18),o=n(25),a=n(81)("IE_PROTO"),i=Object.prototype;e.exports=Object.getPrototypeOf||function(e){return e=o(e),r(e,a)?e[a]:"function"==typeof e.constructor&&e instanceof e.constructor?e.constructor.prototype:e instanceof Object?i:null}},function(e,t,n){"use strict";var r=n(7),o=n(36);e.exports=function(e,t,n){t in e?r.f(e,t,o(0,n)):e[t]=n}},function(e,t,n){e.exports=n(14)},function(e,t,n){var r=n(3).document;e.exports=r&&r.documentElement},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,n){e.exports=n(206)},function(e,t,n){var r=n(9);e.exports=function(e,t,n,o){try{return o?t(r(n)[0],n[1]):t(n)}catch(t){var a=e.return;throw void 0!==a&&r(a.call(e)),t}}},function(e,t,n){var r=n(26),o=n(4)("iterator"),a=Array.prototype;e.exports=function(e){return void 0!==e&&(r.Array===e||a[o]===e)}},function(e,t,n){var r=n(59),o=n(4)("iterator"),a=n(26);e.exports=n(0).getIteratorMethod=function(e){if(null!=e)return e[o]||e["@@iterator"]||a[r(e)]}},function(e,t,n){var r=n(4)("iterator"),o=!1;try{var a=[7][r]();a.return=function(){o=!0},Array.from(a,function(){throw 2})}catch(e){}e.exports=function(e,t){if(!t&&!o)return!1;var n=!1;try{var a=[7],i=a[r]();i.next=function(){return{done:n=!0}},a[r]=function(){return i},e(a)}catch(e){}return n}},function(e,t,n){var r=n(29).f,o=Function.prototype,a=/^\s*function ([^ (]*)/;"name"in o||n(21)&&r(o,"name",{configurable:!0,get:function(){try{return(""+this).match(a)[1]}catch(e){return""}}})},function(e,t,n){var r=n(9),o=n(35),a=n(4)("species");e.exports=function(e,t){var n,i=r(e).constructor;return void 0===i||null==(n=r(i)[a])?t:o(n)}},function(e,t,n){var r,o,a,i=n(12),l=n(215),s=n(112),u=n(77),c=n(3),d=c.process,f=c.setImmediate,h=c.clearImmediate,p=c.MessageChannel,m=c.Dispatch,v=0,_={},y=function(){var e=+this;if(_.hasOwnProperty(e)){var t=_[e];delete _[e],t()}},b=function(e){y.call(e.data)};f&&h||(f=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return _[++v]=function(){l("function"==typeof e?e:Function(e),t)},r(v),v},h=function(e){delete _[e]},"process"==n(38)(d)?r=function(e){d.nextTick(i(y,e,1))}:m&&m.now?r=function(e){m.now(i(y,e,1))}:p?(a=(o=new p).port2,o.port1.onmessage=b,r=i(a.postMessage,a,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(e){c.postMessage(e+"","*")},c.addEventListener("message",b,!1)):r="onreadystatechange"in u("script")?function(e){s.appendChild(u("script")).onreadystatechange=function(){s.removeChild(this),y.call(e)}}:function(e){setTimeout(i(y,e,1),0)}),e.exports={set:f,clear:h}},function(e,t){e.exports=function(e){try{return{e:!1,v:e()}}catch(e){return{e:!0,v:e}}}},function(e,t,n){var r=n(9),o=n(6),a=n(94);e.exports=function(e,t){if(r(e),o(t)&&t.constructor===e)return t;var n=a.f(e);return(0,n.resolve)(t),n.promise}},function(e,t,n){"use strict";var r=n(3),o=n(0),a=n(7),i=n(10),l=n(4)("species");e.exports=function(e){var t="function"==typeof o[e]?o[e]:r[e];i&&t&&!t[l]&&a.f(t,l,{configurable:!0,get:function(){return this}})}},function(e,t,n){var r=n(50),o=n(28);e.exports=function(e){return function(t,n){var a,i,l=String(o(t)),s=r(n),u=l.length;return s<0||s>=u?e?"":void 0:(a=l.charCodeAt(s))<55296||a>56319||s+1===u||(i=l.charCodeAt(s+1))<56320||i>57343?e?l.charAt(s):a:e?l.slice(s,s+2):i-56320+(a-55296<<10)+65536}}},function(e,t,n){var r=n(6);e.exports=function(e,t){if(!r(e)||e._t!==t)throw TypeError("Incompatible receiver, "+t+" required!");return e}},function(e,t,n){"use strict";var r,o,a=n(146),i=RegExp.prototype.exec,l=String.prototype.replace,s=i,u=(r=/a/,o=/b*/g,i.call(r,"a"),i.call(o,"a"),0!==r.lastIndex||0!==o.lastIndex),c=void 0!==/()??/.exec("")[1];(u||c)&&(s=function(e){var t,n,r,o,s=this;return c&&(n=new RegExp("^"+s.source+"$(?!\\s)",a.call(s))),u&&(t=s.lastIndex),r=i.call(s,e),u&&r&&(s.lastIndex=s.global?r.index+r[0].length:t),c&&r&&r.length>1&&l.call(r[0],n,function(){for(o=1;o=t||n<0||f&&e-c>=i}function x(){var e=v();if(g(e))return k(e);s=setTimeout(x,function(e){var n=t-(e-u);return f?m(n,i-(e-c)):n}(e))}function k(e){return s=void 0,h&&o?_(e):(o=a=void 0,l)}function E(){var e=v(),n=g(e);if(o=arguments,a=this,u=e,n){if(void 0===s)return function(e){return c=e,s=setTimeout(x,t),d?_(e):l}(u);if(f)return s=setTimeout(x,t),_(u)}return void 0===s&&(s=setTimeout(x,t)),l}return t=b(t)||0,y(r)&&(d=!!r.leading,i=(f="maxWait"in r)?p(b(r.maxWait)||0,t):i,h="trailing"in r?!!r.trailing:h),E.cancel=function(){void 0!==s&&clearTimeout(s),c=0,o=u=a=s=void 0},E.flush=function(){return void 0===s?l:k(v())},E}function y(e){var t=typeof e;return!!e&&("object"==t||"function"==t)}function b(e){if("number"==typeof e)return e;if(function(e){return"symbol"==typeof e||function(e){return!!e&&"object"==typeof e}(e)&&h.call(e)==o}(e))return r;if(y(e)){var t="function"==typeof e.valueOf?e.valueOf():e;e=y(t)?t+"":t}if("string"!=typeof e)return 0===e?e:+e;e=e.replace(a,"");var n=l.test(e);return n||s.test(e)?u(e.slice(2),n?2:8):i.test(e)?r:+e}e.exports=function(e,t,r){var o=!0,a=!0;if("function"!=typeof e)throw new TypeError(n);return y(r)&&(o="leading"in r?!!r.leading:o,a="trailing"in r?!!r.trailing:a),_(e,t,{leading:o,maxWait:t,trailing:a})}},function(e,t,n){e.exports=n(240)},function(e,t,n){e.exports=n(242)},function(e,t,n){"use strict";var r=n(11),o=n(34),a=n(22),i=n(50),l=n(143),s=n(144),u=Math.max,c=Math.min,d=Math.floor,f=/\$([$&`']|\d\d?|<[^>]*>)/g,h=/\$([$&`']|\d\d?)/g;n(145)("replace",2,function(e,t,n,p){return[function(r,o){var a=e(this),i=null==r?void 0:r[t];return void 0!==i?i.call(r,a,o):n.call(String(a),r,o)},function(e,t){var o=p(n,e,this,t);if(o.done)return o.value;var d=r(e),f=String(this),h="function"==typeof t;h||(t=String(t));var v=d.global;if(v){var _=d.unicode;d.lastIndex=0}for(var y=[];;){var b=s(d,f);if(null===b)break;if(y.push(b),!v)break;""===String(b[0])&&(d.lastIndex=l(f,a(d.lastIndex),_))}for(var g,x="",k=0,E=0;E=k&&(x+=f.slice(k,A)+O,k=A+w.length)}return x+f.slice(k)}];function m(e,t,r,a,i,l){var s=r+e.length,u=a.length,c=h;return void 0!==i&&(i=o(i),c=f),n.call(l,c,function(n,o){var l;switch(o.charAt(0)){case"$":return"$";case"&":return e;case"`":return t.slice(0,r);case"'":return t.slice(s);case"<":l=i[o.slice(1,-1)];break;default:var c=+o;if(0===c)return n;if(c>u){var f=d(c/10);return 0===f?n:f<=u?void 0===a[f-1]?o.charAt(1):a[f-1]+o.charAt(1):n}l=a[c-1]}return void 0===l?"":l})}})},function(e,t,n){e.exports=!n(21)&&!n(27)(function(){return 7!=Object.defineProperty(n(72)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(15);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},function(e,t,n){var r=n(48),o=n(65),a=n(139)(!1),i=n(74)("IE_PROTO");e.exports=function(e,t){var n,l=o(e),s=0,u=[];for(n in l)n!=i&&r(l,n)&&u.push(n);for(;t.length>s;)r(l,n=t[s++])&&(~a(u,n)||u.push(n));return u}},function(e,t,n){var r=n(65),o=n(22),a=n(154);e.exports=function(e){return function(t,n,i){var l,s=r(t),u=o(s.length),c=a(i,u);if(e&&n!=n){for(;u>c;)if((l=s[c++])!=l)return!0}else for(;u>c;c++)if((e||c in s)&&s[c]===n)return e||c||0;return!e&&-1}}},function(e,t,n){"use strict";var r=n(5),o=n(29),a=n(21),i=n(2)("species");e.exports=function(e){var t=r[e];a&&t&&!t[i]&&o.f(t,i,{configurable:!0,get:function(){return this}})}},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,n){var r=n(15),o=n(24),a=n(2)("match");e.exports=function(e){var t;return r(e)&&(void 0!==(t=e[a])?!!t:"RegExp"==o(e))}},function(e,t,n){"use strict";var r=n(125)(!0);e.exports=function(e,t,n){return t+(n?r(e,t).length:1)}},function(e,t,n){"use strict";var r=n(76),o=RegExp.prototype.exec;e.exports=function(e,t){var n=e.exec;if("function"==typeof n){var a=n.call(e,t);if("object"!=typeof a)throw new TypeError("RegExp exec method returned something other than an Object or null");return a}if("RegExp"!==r(e))throw new TypeError("RegExp#exec called on incompatible receiver");return o.call(e,t)}},function(e,t,n){"use strict";n(244);var r=n(30),o=n(17),a=n(27),i=n(28),l=n(2),s=n(127),u=l("species"),c=!a(function(){var e=/./;return e.exec=function(){var e=[];return e.groups={a:"7"},e},"7"!=="".replace(e,"$")}),d=function(){var e=/(?:)/,t=e.exec;e.exec=function(){return t.apply(this,arguments)};var n="ab".split(e);return 2===n.length&&"a"===n[0]&&"b"===n[1]}();e.exports=function(e,t,n){var f=l(e),h=!a(function(){var t={};return t[f]=function(){return 7},7!=""[e](t)}),p=h?!a(function(){var t=!1,n=/a/;return n.exec=function(){return t=!0,null},"split"===e&&(n.constructor={},n.constructor[u]=function(){return n}),n[f](""),!t}):void 0;if(!h||!p||"replace"===e&&!c||"split"===e&&!d){var m=/./[f],v=n(i,f,""[e],function(e,t,n,r,o){return t.exec===s?h&&!o?{done:!0,value:m.call(t,n,r)}:{done:!0,value:e.call(n,t,r)}:{done:!1}}),_=v[0],y=v[1];r(String.prototype,e,_),o(RegExp.prototype,f,2==t?function(e,t){return y.call(e,this,t)}:function(e){return y.call(e,this)})}}},function(e,t,n){"use strict";var r=n(11);e.exports=function(){var e=r(this),t="";return e.global&&(t+="g"),e.ignoreCase&&(t+="i"),e.multiline&&(t+="m"),e.unicode&&(t+="u"),e.sticky&&(t+="y"),t}},function(e,t,n){e.exports=n(246)},function(e,t,n){var r=n(2)("unscopables"),o=Array.prototype;null==o[r]&&n(17)(o,r,{}),e.exports=function(e){o[r][e]=!0}},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,n){e.exports=n(69)("native-function-to-string",Function.toString)},function(e,t,n){"use strict";var r=n(152),o=n(98),a=n(75),i={};n(17)(i,n(2)("iterator"),function(){return this}),e.exports=function(e,t,n){e.prototype=r(i,{next:o(1,n)}),a(e,t+" Iterator")}},function(e,t,n){var r=n(11),o=n(153),a=n(99),i=n(74)("IE_PROTO"),l=function(){},s=function(){var e,t=n(72)("iframe"),r=a.length;for(t.style.display="none",n(102).appendChild(t),t.src="javascript:",(e=t.contentWindow.document).open(),e.write(" +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/chainspec/index.html b/docs/.vuepress/dist/chainspec/index.html index 3fb5bd5a2..6bf500789 100644 --- a/docs/.vuepress/dist/chainspec/index.html +++ b/docs/.vuepress/dist/chainspec/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/chainspec

Chainspecs for known chains

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/chainspec

Chainspecs for known chains

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html b/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html index 18563931f..278fb2594 100644 --- a/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html +++ b/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html b/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html index 6c9fa16c6..836ff38fc 100644 --- a/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html +++ b/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/chainspec/modules/_types_.html b/docs/.vuepress/dist/chainspec/modules/_types_.html index e50a7e12c..3f6dc148c 100644 --- a/docs/.vuepress/dist/chainspec/modules/_types_.html +++ b/docs/.vuepress/dist/chainspec/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Chainspec

Ƭ Chainspec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Chainspec

Ƭ Chainspec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/SUMMARY.html b/docs/.vuepress/dist/db/SUMMARY.html index 84cc8b717..5d9b76fcc 100644 --- a/docs/.vuepress/dist/db/SUMMARY.html +++ b/docs/.vuepress/dist/db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_disk_.diskdb.html b/docs/.vuepress/dist/db/classes/_disk_.diskdb.html index 222a80e5e..94ebdccb3 100644 --- a/docs/.vuepress/dist/db/classes/_disk_.diskdb.html +++ b/docs/.vuepress/dist/db/classes/_disk_.diskdb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

name: DiskDb

summary: Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.

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

example:

import stringToU8a from '@polkadot/util/string/toU8a';
+

name: DiskDb

summary: Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.

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

example:

import stringToU8a from '@polkadot/util/string/toU8a';
 import DiskDb from '@polkadot/db/Disk';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
 
@@ -58,7 +58,7 @@ console.log<
 
 // Close the diskDb database and clear Lru cache
 diskDb.close();
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Hierarchy

TransactionDb

↳ DiskDb

Implements

Constructors

constructor

⊕ new DiskDb(base: string, name: string, options?: BaseDbOptions): DiskDb

Overrides TransactionDb.constructor

Defined in Disk.ts:66

Parameters:

Name Type
base string
name string
Optional options BaseDbOptions

Returns: DiskDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Hierarchy

TransactionDb

↳ DiskDb

Implements

Constructors

constructor

⊕ new DiskDb(base: string, name: string, options?: BaseDbOptions): DiskDb

Overrides TransactionDb.constructor

Defined in Disk.ts:66

Parameters:

Name Type
base string
name string
Optional options BaseDbOptions

Returns: DiskDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_engines_filetreedb_.filetreedb.html b/docs/.vuepress/dist/db/classes/_engines_filetreedb_.filetreedb.html index bae0f1480..07d8f3990 100644 --- a/docs/.vuepress/dist/db/classes/_engines_filetreedb_.filetreedb.html +++ b/docs/.vuepress/dist/db/classes/_engines_filetreedb_.filetreedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

FileTreeDb

Implements

Constructors

constructor

⊕ new FileTreeDb(location: string): FileTreeDb

Defined in engines/FileTreeDb.ts:21

Parameters:

Name Type
location string

Returns: FileTreeDb

Properties

_location

● _location: string

Defined in engines/FileTreeDb.ts:21

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/FileTreeDb.ts:46

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/FileTreeDb.ts:76

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/FileTreeDb.ts:50

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/FileTreeDb.ts:54

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/FileTreeDb.ts:86

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/FileTreeDb.ts:68

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/FileTreeDb.ts:42

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/FileTreeDb.ts:100

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/FileTreeDb.ts:58

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/FileTreeDb.ts:62

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

FileTreeDb

Implements

Constructors

constructor

⊕ new FileTreeDb(location: string): FileTreeDb

Defined in engines/FileTreeDb.ts:21

Parameters:

Name Type
location string

Returns: FileTreeDb

Properties

_location

● _location: string

Defined in engines/FileTreeDb.ts:21

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/FileTreeDb.ts:46

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/FileTreeDb.ts:76

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/FileTreeDb.ts:50

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/FileTreeDb.ts:54

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/FileTreeDb.ts:86

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/FileTreeDb.ts:68

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/FileTreeDb.ts:42

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/FileTreeDb.ts:100

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/FileTreeDb.ts:58

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/FileTreeDb.ts:62

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_engines_lrudb_.lrudb.html b/docs/.vuepress/dist/db/classes/_engines_lrudb_.lrudb.html index 528290ed7..a82367bc6 100644 --- a/docs/.vuepress/dist/db/classes/_engines_lrudb_.lrudb.html +++ b/docs/.vuepress/dist/db/classes/_engines_lrudb_.lrudb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

LruDb

Implements

Constructors

constructor

⊕ new LruDb(backing: BaseDb, itemCount?: number): LruDb

Defined in engines/LruDb.ts:20

Parameters:

Name Type Default value
backing BaseDb -
Default value itemCount number DEFAULT_ITEM_COUNT

Returns: LruDb

Methods

_getLru

▸ _getLru(key: Uint8Array): CachedValue | undefined

Defined in engines/LruDb.ts:87

Parameters:

Name Type
key Uint8Array

Returns: CachedValue | undefined

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/LruDb.ts:27

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/LruDb.ts:64

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/LruDb.ts:41

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/LruDb.ts:45

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/LruDb.ts:71

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/LruDb.ts:56

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/LruDb.ts:34

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/LruDb.ts:91

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/LruDb.ts:52

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/LruDb.ts:60

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

LruDb

Implements

Constructors

constructor

⊕ new LruDb(backing: BaseDb, itemCount?: number): LruDb

Defined in engines/LruDb.ts:20

Parameters:

Name Type Default value
backing BaseDb -
Default value itemCount number DEFAULT_ITEM_COUNT

Returns: LruDb

Methods

_getLru

▸ _getLru(key: Uint8Array): CachedValue | undefined

Defined in engines/LruDb.ts:87

Parameters:

Name Type
key Uint8Array

Returns: CachedValue | undefined

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/LruDb.ts:27

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/LruDb.ts:64

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/LruDb.ts:41

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/LruDb.ts:45

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/LruDb.ts:71

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/LruDb.ts:56

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/LruDb.ts:34

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/LruDb.ts:91

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/LruDb.ts:52

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/LruDb.ts:60

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_engines_memorydb_.memorydb.html b/docs/.vuepress/dist/db/classes/_engines_memorydb_.memorydb.html index 407637100..b65f14793 100644 --- a/docs/.vuepress/dist/db/classes/_engines_memorydb_.memorydb.html +++ b/docs/.vuepress/dist/db/classes/_engines_memorydb_.memorydb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

MemoryDb

Implements

Constructors

constructor

⊕ new MemoryDb(options?: BaseDbOptions): MemoryDb

Defined in engines/MemoryDb.ts:16

Parameters:

Name Type
Optional options BaseDbOptions

Returns: MemoryDb

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/MemoryDb.ts:22

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/MemoryDb.ts:56

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/MemoryDb.ts:30

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/MemoryDb.ts:34

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/MemoryDb.ts:62

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/MemoryDb.ts:42

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/MemoryDb.ts:26

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/MemoryDb.ts:68

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/MemoryDb.ts:38

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/MemoryDb.ts:50

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

MemoryDb

Implements

Constructors

constructor

⊕ new MemoryDb(options?: BaseDbOptions): MemoryDb

Defined in engines/MemoryDb.ts:16

Parameters:

Name Type
Optional options BaseDbOptions

Returns: MemoryDb

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/MemoryDb.ts:22

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/MemoryDb.ts:56

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/MemoryDb.ts:30

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/MemoryDb.ts:34

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/MemoryDb.ts:62

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/MemoryDb.ts:42

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/MemoryDb.ts:26

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/MemoryDb.ts:68

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/MemoryDb.ts:38

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/MemoryDb.ts:50

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_engines_transactiondb_.transactiondb.html b/docs/.vuepress/dist/db/classes/_engines_transactiondb_.transactiondb.html index b9d11817e..1308b48f3 100644 --- a/docs/.vuepress/dist/db/classes/_engines_transactiondb_.transactiondb.html +++ b/docs/.vuepress/dist/db/classes/_engines_transactiondb_.transactiondb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

TransactionDb

↳ DiskDb

↳ Memory

Implements

Constructors

constructor

⊕ new TransactionDb(backing: BaseDb): TransactionDb

Defined in engines/TransactionDb.ts:21

Parameters:

Name Type
backing BaseDb

Returns: TransactionDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

TransactionDb

↳ DiskDb

↳ Memory

Implements

Constructors

constructor

⊕ new TransactionDb(backing: BaseDb): TransactionDb

Defined in engines/TransactionDb.ts:21

Parameters:

Name Type
backing BaseDb

Returns: TransactionDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_fileflatdb_cache_.cache.html b/docs/.vuepress/dist/db/classes/_fileflatdb_cache_.cache.html index d75d945ed..a217348d3 100644 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_cache_.cache.html +++ b/docs/.vuepress/dist/db/classes/_fileflatdb_cache_.cache.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

↳ File

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Cache(base: string, file: string, options: BaseDbOptions): Cache

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Cache

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

↳ File

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Cache(base: string, file: string, options: BaseDbOptions): Cache

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Cache

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_fileflatdb_compact_.compact.html b/docs/.vuepress/dist/db/classes/_fileflatdb_compact_.compact.html index c96d41ef1..e86129fc7 100644 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_compact_.compact.html +++ b/docs/.vuepress/dist/db/classes/_fileflatdb_compact_.compact.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Compact

Constructors

constructor

⊕ new Compact(file: string): Compact

Defined in FileFlatDb/Compact.ts:17

Parameters:

Name Type
file string

Returns: Compact

Methods

maintain

▸ maintain(fn: ProgressCb): void

Defined in FileFlatDb/Compact.ts:24

Parameters:

Name Type
fn ProgressCb

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Compact

Constructors

constructor

⊕ new Compact(file: string): Compact

Defined in FileFlatDb/Compact.ts:17

Parameters:

Name Type
file string

Returns: Compact

Methods

maintain

▸ maintain(fn: ProgressCb): void

Defined in FileFlatDb/Compact.ts:24

Parameters:

Name Type
fn ProgressCb

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_fileflatdb_file_.file.html b/docs/.vuepress/dist/db/classes/_fileflatdb_file_.file.html index 2e1346fb1..b29f9bd0d 100644 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_file_.file.html +++ b/docs/.vuepress/dist/db/classes/_fileflatdb_file_.file.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Serialize

↳ File

↳ Cache

Constructors

constructor

⊕ new File(base: string, file: string, options: BaseDbOptions): File

Defined in FileFlatDb/File.ts:19

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: File

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Serialize

↳ File

↳ Cache

Constructors

constructor

⊕ new File(base: string, file: string, options: BaseDbOptions): File

Defined in FileFlatDb/File.ts:19

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: File

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_fileflatdb_impl_.impl.html b/docs/.vuepress/dist/db/classes/_fileflatdb_impl_.impl.html index 80c9e7456..bdfb3e3e6 100644 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_impl_.impl.html +++ b/docs/.vuepress/dist/db/classes/_fileflatdb_impl_.impl.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Impl(base: string, file: string, options: BaseDbOptions): Impl

Inherited from Cache.constructor

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Impl

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Impl(base: string, file: string, options: BaseDbOptions): Impl

Inherited from Cache.constructor

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Impl

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/classes/_fileflatdb_serialize_.serialize.html b/docs/.vuepress/dist/db/classes/_fileflatdb_serialize_.serialize.html index b57d90500..0e307531a 100644 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_serialize_.serialize.html +++ b/docs/.vuepress/dist/db/classes/_fileflatdb_serialize_.serialize.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Serialize

↳ File

Last Updated: 2/13/2019, 4:33:49 PM
- +

Hierarchy

Serialize

↳ File

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/classes/_memory_.memory.html b/docs/.vuepress/dist/db/classes/_memory_.memory.html index cceb20aa5..f84f1d138 100644 --- a/docs/.vuepress/dist/db/classes/_memory_.memory.html +++ b/docs/.vuepress/dist/db/classes/_memory_.memory.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

name: MemoryDb

summary: Creates a MemoryDb database extending TransactionDb

description: Create an instance of a Memory database using MemoryDb and extending TransactionDb. options argument (optional) used to specifies whether to use compression.

  • Enable compression when storing "blocks" since they compress well.
  • 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:

import stringToU8a from '@polkadot/util/string/toU8a';
+

name: MemoryDb

summary: Creates a MemoryDb database extending TransactionDb

description: Create an instance of a Memory database using MemoryDb and extending TransactionDb. options argument (optional) used to specifies whether to use compression.

  • Enable compression when storing "blocks" since they compress well.
  • 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:

import stringToU8a from '@polkadot/util/string/toU8a';
 import MemoryDb from '@polkadot/db/Memory';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
 
@@ -53,7 +53,7 @@ console.log<
 
 // Close the memory database
 memoryDb.close();
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Hierarchy

TransactionDb

↳ Memory

Implements

Constructors

constructor

⊕ new Memory(options?: BaseDbOptions): Memory

Overrides TransactionDb.constructor

Defined in Memory.ts:66

Parameters:

Name Type
Optional options BaseDbOptions

Returns: Memory

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Hierarchy

TransactionDb

↳ Memory

Implements

Constructors

constructor

⊕ new Memory(options?: BaseDbOptions): Memory

Overrides TransactionDb.constructor

Defined in Memory.ts:66

Parameters:

Name Type
Optional options BaseDbOptions

Returns: Memory

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/enums/_fileflatdb_types_.slot.html b/docs/.vuepress/dist/db/enums/_fileflatdb_types_.slot.html index 15d2833b6..d01f33bd0 100644 --- a/docs/.vuepress/dist/db/enums/_fileflatdb_types_.slot.html +++ b/docs/.vuepress/dist/db/enums/_fileflatdb_types_.slot.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 1

Defined in FileFlatDb/types.ts:7

EMPTY

EMPTY: = 0

Defined in FileFlatDb/types.ts:6

LEAF

LEAF: = 2

Defined in FileFlatDb/types.ts:8

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 1

Defined in FileFlatDb/types.ts:7

EMPTY

EMPTY: = 0

Defined in FileFlatDb/types.ts:6

LEAF

LEAF: = 2

Defined in FileFlatDb/types.ts:8

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/index.html b/docs/.vuepress/dist/db/index.html index be19f1f7c..861b20daa 100644 --- a/docs/.vuepress/dist/db/index.html +++ b/docs/.vuepress/dist/db/index.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

@polkadot/db

This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client

Usage

Installation -

yarn add @polkadot/db
+

@polkadot/db

This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client

Usage

Installation -

yarn add @polkadot/db
1

Classes can be imported as follows:

// Default exports
 import DiskDb from '@polkadot/db/Disk';
 import MemoryDb from '@polkadot/db/Memory';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
1
2
3
4

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/.vuepress/dist/db/interfaces/_types_.basedb.html b/docs/.vuepress/dist/db/interfaces/_types_.basedb.html index 44bd4009f..3cdc1acc2 100644 --- a/docs/.vuepress/dist/db/interfaces/_types_.basedb.html +++ b/docs/.vuepress/dist/db/interfaces/_types_.basedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Defined in types.ts:24

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Defined in types.ts:24

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/interfaces/_types_.txdb.html b/docs/.vuepress/dist/db/interfaces/_types_.txdb.html index afb3a0901..bf767f6a4 100644 --- a/docs/.vuepress/dist/db/interfaces/_types_.txdb.html +++ b/docs/.vuepress/dist/db/interfaces/_types_.txdb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in types.ts:24

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in types.ts:24

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/modules/_disk_.html b/docs/.vuepress/dist/db/modules/_disk_.html index 5fb073147..3d79036ca 100644 --- a/docs/.vuepress/dist/db/modules/_disk_.html +++ b/docs/.vuepress/dist/db/modules/_disk_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html b/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html index 480148d22..0e42fa62a 100644 --- a/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html +++ b/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_engines_lrudb_.html b/docs/.vuepress/dist/db/modules/_engines_lrudb_.html index 4d82da7cf..810625828 100644 --- a/docs/.vuepress/dist/db/modules/_engines_lrudb_.html +++ b/docs/.vuepress/dist/db/modules/_engines_lrudb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_engines_memorydb_.html b/docs/.vuepress/dist/db/modules/_engines_memorydb_.html index b0ddcc235..832751acf 100644 --- a/docs/.vuepress/dist/db/modules/_engines_memorydb_.html +++ b/docs/.vuepress/dist/db/modules/_engines_memorydb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html b/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html index 294008632..8527357c2 100644 --- a/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html +++ b/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html index a80fff09b..7ac942494 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html index 2e8191419..495e86bdb 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html index 97b74be88..beb6262a5 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html index 985c018db..627b13c89 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html index e64bc91cd..6cc5b7fd7 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html index a009a244c..95ad4c8bb 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html index 5c8a589f6..742e8cf1c 100644 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html +++ b/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumerations

Type aliases

Type aliases

Key

Ƭ Key: object

Defined in FileFlatDb/types.ts:16

Type declaration

NibbleBuffer

Ƭ NibbleBuffer: object

Defined in FileFlatDb/types.ts:11

Type declaration

Value

Ƭ Value: object

Defined in FileFlatDb/types.ts:22

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumerations

Type aliases

Type aliases

Key

Ƭ Key: object

Defined in FileFlatDb/types.ts:16

Type declaration

NibbleBuffer

Ƭ NibbleBuffer: object

Defined in FileFlatDb/types.ts:11

Type declaration

Value

Ƭ Value: object

Defined in FileFlatDb/types.ts:22

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/db/modules/_memory_.html b/docs/.vuepress/dist/db/modules/_memory_.html index cc9685208..e2c847e20 100644 --- a/docs/.vuepress/dist/db/modules/_memory_.html +++ b/docs/.vuepress/dist/db/modules/_memory_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/db/modules/_types_.html b/docs/.vuepress/dist/db/modules/_types_.html index e83704b31..c1c20e6e4 100644 --- a/docs/.vuepress/dist/db/modules/_types_.html +++ b/docs/.vuepress/dist/db/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

BaseDbOptions

Ƭ BaseDbOptions: object

Defined in types.ts:13

Type declaration

ProgressCb

Ƭ ProgressCb: function

Defined in types.ts:11

Type declaration

▸(progress: ProgressValue): void

Parameters:

Name Type
progress ProgressValue

Returns: void

ProgressValue

Ƭ ProgressValue: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

BaseDbOptions

Ƭ BaseDbOptions: object

Defined in types.ts:13

Type declaration

ProgressCb

Ƭ ProgressCb: function

Defined in types.ts:11

Type declaration

▸(progress: ProgressValue): void

Parameters:

Name Type
progress ProgressValue

Returns: void

ProgressValue

Ƭ ProgressValue: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/examples/keyring/01_create_account/index.html b/docs/.vuepress/dist/examples/keyring/01_create_account/index.html index 6c01e4346..364120c29 100644 --- a/docs/.vuepress/dist/examples/keyring/01_create_account/index.html +++ b/docs/.vuepress/dist/examples/keyring/01_create_account/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create Account

The following example shows how to create and account with keyring.

// Import Keyring class and utility function
+

Create Account

The following example shows how to create and account with keyring.

// Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;
 
@@ -39,6 +39,6 @@
         
         →
- + diff --git a/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html b/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html index d19c6ac82..edb69c231 100644 --- a/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html +++ b/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Load Accounts

The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.

// Import Keyring class and utility function
+

Load Accounts

The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.

// Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;
 
@@ -51,10 +51,10 @@
          
-          /util/
+          @polkadot/util
         
         →
- + diff --git a/docs/.vuepress/dist/examples/keyring/index.html b/docs/.vuepress/dist/examples/keyring/index.html index 352e3fb4d..a70c46775 100644 --- a/docs/.vuepress/dist/examples/keyring/index.html +++ b/docs/.vuepress/dist/examples/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Keyring Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Keyring Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/01_create_patricia_trie/index.html b/docs/.vuepress/dist/examples/trie-db/01_create_patricia_trie/index.html index d3c351c22..8f5eb6d50 100644 --- a/docs/.vuepress/dist/examples/trie-db/01_create_patricia_trie/index.html +++ b/docs/.vuepress/dist/examples/trie-db/01_create_patricia_trie/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create Patricia Trie

The following example shows how to create a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Create Patricia Trie

The following example shows how to create a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/02_get_set_del_trie_nodes/index.html b/docs/.vuepress/dist/examples/trie-db/02_get_set_del_trie_nodes/index.html index f0b5b249d..a0e010038 100644 --- a/docs/.vuepress/dist/examples/trie-db/02_get_set_del_trie_nodes/index.html +++ b/docs/.vuepress/dist/examples/trie-db/02_get_set_del_trie_nodes/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Get & Set & Delete Trie Nodes

The following example shows how to get, set, and delete nodes of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Get & Set & Delete Trie Nodes

The following example shows how to get, set, and delete nodes of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/03_duplicate_trie_with_snapshot/index.html b/docs/.vuepress/dist/examples/trie-db/03_duplicate_trie_with_snapshot/index.html index 4f43e7c17..b88b2a9b5 100644 --- a/docs/.vuepress/dist/examples/trie-db/03_duplicate_trie_with_snapshot/index.html +++ b/docs/.vuepress/dist/examples/trie-db/03_duplicate_trie_with_snapshot/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Duplicate Patricia Trie with Snapshot

The following example shows how to duplicate a Patricia Trie by taking a snapshot.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Duplicate Patricia Trie with Snapshot

The following example shows how to duplicate a Patricia Trie by taking a snapshot.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/04_show_size_trie_node_info/index.html b/docs/.vuepress/dist/examples/trie-db/04_show_size_trie_node_info/index.html index 423356d6d..cc95cbee9 100644 --- a/docs/.vuepress/dist/examples/trie-db/04_show_size_trie_node_info/index.html +++ b/docs/.vuepress/dist/examples/trie-db/04_show_size_trie_node_info/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Show Size and Node Info of a Patricia Trie

The following example shows how to show the size and node information of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Show Size and Node Info of a Patricia Trie

The following example shows how to show the size and node information of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/05_empty_close_drop_trie/index.html b/docs/.vuepress/dist/examples/trie-db/05_empty_close_drop_trie/index.html index 5441010c4..c2c55d5ea 100644 --- a/docs/.vuepress/dist/examples/trie-db/05_empty_close_drop_trie/index.html +++ b/docs/.vuepress/dist/examples/trie-db/05_empty_close_drop_trie/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Empty & Close & Drop a Patricia Trie

The following example shows how to empty, close, and drop a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Empty & Close & Drop a Patricia Trie

The following example shows how to empty, close, and drop a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/trie-db/index.html b/docs/.vuepress/dist/examples/trie-db/index.html index ffe1666e5..f9bec2503 100644 --- a/docs/.vuepress/dist/examples/trie-db/index.html +++ b/docs/.vuepress/dist/examples/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Trie-DB Examples

Here you will find a list of examples that takes you through the basics of creating a Patricia Trie, creating key/value pair branches, retrieving the value of a branch with its key, deleting branches, saving the root node hash to a variable and then later setting the root node hash to restore the trie to its previous state, duplicating the trie with a snapshot, showing the size of the trie and other node information, and emptying, closing, and dropping the trie.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Trie-DB Examples

Here you will find a list of examples that takes you through the basics of creating a Patricia Trie, creating key/value pair branches, retrieving the value of a branch with its key, deleting branches, saving the root node hash to a variable and then later setting the root node hash to restore the trie to its previous state, duplicating the trie with a snapshot, showing the size of the trie and other node information, and emptying, closing, and dropping the trie.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html b/docs/.vuepress/dist/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html index ebb86664f..3be137767 100644 --- a/docs/.vuepress/dist/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html +++ b/docs/.vuepress/dist/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Encrypt & Decrypt Message using NaCl

The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Encrypt & Decrypt Message using NaCl

The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/util-crypto/02_sign_verify_message_nacl/index.html b/docs/.vuepress/dist/examples/util-crypto/02_sign_verify_message_nacl/index.html index 64aaa7a3a..1b6a07a71 100644 --- a/docs/.vuepress/dist/examples/util-crypto/02_sign_verify_message_nacl/index.html +++ b/docs/.vuepress/dist/examples/util-crypto/02_sign_verify_message_nacl/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Sign & Verify Message using NaCl

The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Sign & Verify Message using NaCl

The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html b/docs/.vuepress/dist/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html index db614bbe9..391ea8b95 100644 --- a/docs/.vuepress/dist/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html +++ b/docs/.vuepress/dist/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create & Generate Mnemonic using BIP39

The following example shows how to create and generate mnemonics using BIP39.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Create & Generate Mnemonic using BIP39

The following example shows how to create and generate mnemonics using BIP39.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/examples/util-crypto/index.html b/docs/.vuepress/dist/examples/util-crypto/index.html index 5acbe0869..223276288 100644 --- a/docs/.vuepress/dist/examples/util-crypto/index.html +++ b/docs/.vuepress/dist/examples/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Util-Crypto Examples

Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Util-Crypto Examples

Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/index.html b/docs/.vuepress/dist/index.html index 508eb0a65..96a21056a 100644 --- a/docs/.vuepress/dist/index.html +++ b/docs/.vuepress/dist/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Polkadot Javascript Common

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

It is split up into a number of internal packages, namely utilities -

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/common

Contributing

Contribution to Polkadot JS Common are more than welcome. You can report issues and log feature requests.

Last Updated: 2/26/2019, 10:14:20 AM
- +

Polkadot Javascript Common

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

It is split up into a number of internal packages, namely utilities -

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/common

Contributing

Contribution to Polkadot JS Common are more than welcome. You can report issues and log feature requests.

Last Updated: 2/26/2019, 10:14:20 AM
+ diff --git a/docs/.vuepress/dist/keyring/SUMMARY.html b/docs/.vuepress/dist/keyring/SUMMARY.html index 45a92ae20..3cd81ecbf 100644 --- a/docs/.vuepress/dist/keyring/SUMMARY.html +++ b/docs/.vuepress/dist/keyring/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html b/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html index c24e2a6f6..ea8c1426d 100644 --- a/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html +++ b/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Pairs

Implements

Constructors

constructor

⊕ new Pairs(): Pairs

Defined in pairs.ts:17

Returns: Pairs

Methods

add

▸ add(pair: KeyringPair): KeyringPair

Defined in pairs.ts:23

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

▸ all(): Array<KeyringPair>

Defined in pairs.ts:30

Returns: Array<KeyringPair>

get

▸ get(address: string | Uint8Array): KeyringPair

Defined in pairs.ts:34

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

▸ remove(address: string | Uint8Array): void

Defined in pairs.ts:49

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Pairs

Implements

Constructors

constructor

⊕ new Pairs(): Pairs

Defined in pairs.ts:17

Returns: Pairs

Methods

add

▸ add(pair: KeyringPair): KeyringPair

Defined in pairs.ts:23

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

▸ all(): Array<KeyringPair>

Defined in pairs.ts:30

Returns: Array<KeyringPair>

get

▸ get(address: string | Uint8Array): KeyringPair

Defined in pairs.ts:34

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

▸ remove(address: string | Uint8Array): void

Defined in pairs.ts:49

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/index.html b/docs/.vuepress/dist/keyring/index.html index ecf513207..efdb4c02e 100644 --- a/docs/.vuepress/dist/keyring/index.html +++ b/docs/.vuepress/dist/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/keyring

Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage

Installation -

yarn add @polkadot/keyring
+

@polkadot/keyring

Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage

Installation -

yarn add @polkadot/keyring
1

Classes and Functions can be imported as follows:

import Keyring from '@polkadot/keyring';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← Contributing →

- + diff --git a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringinstance.html b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringinstance.html index 2615a57ef..42b57a2d4 100644 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringinstance.html +++ b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringinstance.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringInstance

Properties

pairs

● pairs: Array<KeyringPair>

Defined in types.ts:58

publicKeys

● publicKeys: Array<Uint8Array>

Defined in types.ts:59

type

● type: KeyringPairType

Defined in types.ts:60

Methods

addFromAddress

▸ addFromAddress(address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeyringPairType): KeyringPair

Defined in types.ts:67

Parameters:

Name Type
address string | Uint8Array
Optional meta KeyringPair$Meta
Optional encoded Uint8Array | null
Optional type KeyringPairType

Returns: KeyringPair

addFromJson

▸ addFromJson(pair: KeyringPair$Json): KeyringPair

Defined in types.ts:70

Parameters:

Name Type
pair KeyringPair$Json

Returns: KeyringPair

addFromMnemonic

▸ addFromMnemonic(mnemonic: string, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:68

Parameters:

Name Type
mnemonic string
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addFromSeed

▸ addFromSeed(seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:69

Parameters:

Name Type
seed Uint8Array
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addPair

▸ addPair(pair: KeyringPair): KeyringPair

Defined in types.ts:66

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

decodeAddress

▸ decodeAddress(encoded: string | Uint8Array): Uint8Array

Defined in types.ts:62

Parameters:

Name Type
encoded string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: Uint8Array | string): string

Defined in types.ts:63

Parameters:

Name Type
key Uint8Array | string

Returns: string

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Defined in types.ts:71

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Defined in types.ts:72

Returns: Array<KeyringPair>

getPublicKeys

▸ getPublicKeys(): Array<Uint8Array>

Defined in types.ts:73

Returns: Array<Uint8Array>

removePair

▸ removePair(address: string | Uint8Array): void

Defined in types.ts:74

Parameters:

Name Type
address string | Uint8Array

Returns: void

setAddressPrefix

▸ setAddressPrefix(prefix: Prefix): void

Defined in types.ts:64

Parameters:

Name Type
prefix Prefix

Returns: void

toJson

▸ toJson(address: string | Uint8Array, passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:75

Parameters:

Name Type
address string | Uint8Array
Optional passphrase undefined | string

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringInstance

Properties

pairs

● pairs: Array<KeyringPair>

Defined in types.ts:58

publicKeys

● publicKeys: Array<Uint8Array>

Defined in types.ts:59

type

● type: KeyringPairType

Defined in types.ts:60

Methods

addFromAddress

▸ addFromAddress(address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeyringPairType): KeyringPair

Defined in types.ts:67

Parameters:

Name Type
address string | Uint8Array
Optional meta KeyringPair$Meta
Optional encoded Uint8Array | null
Optional type KeyringPairType

Returns: KeyringPair

addFromJson

▸ addFromJson(pair: KeyringPair$Json): KeyringPair

Defined in types.ts:70

Parameters:

Name Type
pair KeyringPair$Json

Returns: KeyringPair

addFromMnemonic

▸ addFromMnemonic(mnemonic: string, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:68

Parameters:

Name Type
mnemonic string
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addFromSeed

▸ addFromSeed(seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:69

Parameters:

Name Type
seed Uint8Array
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addPair

▸ addPair(pair: KeyringPair): KeyringPair

Defined in types.ts:66

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

decodeAddress

▸ decodeAddress(encoded: string | Uint8Array): Uint8Array

Defined in types.ts:62

Parameters:

Name Type
encoded string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: Uint8Array | string): string

Defined in types.ts:63

Parameters:

Name Type
key Uint8Array | string

Returns: string

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Defined in types.ts:71

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Defined in types.ts:72

Returns: Array<KeyringPair>

getPublicKeys

▸ getPublicKeys(): Array<Uint8Array>

Defined in types.ts:73

Returns: Array<Uint8Array>

removePair

▸ removePair(address: string | Uint8Array): void

Defined in types.ts:74

Parameters:

Name Type
address string | Uint8Array

Returns: void

setAddressPrefix

▸ setAddressPrefix(prefix: Prefix): void

Defined in types.ts:64

Parameters:

Name Type
prefix Prefix

Returns: void

toJson

▸ toJson(address: string | Uint8Array, passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:75

Parameters:

Name Type
address string | Uint8Array
Optional passphrase undefined | string

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpair.html b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpair.html index 71e7a878c..4b2b986f4 100644 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpair.html +++ b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpair.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringPair

Properties

address

● address: function

Defined in types.ts:36

Type declaration

▸(): string

Returns: string

decodePkcs8

● decodePkcs8: function

Defined in types.ts:37

Type declaration

▸(passphrase?: undefined | string, encoded?: Uint8Array): void

Parameters:

Name Type
Optional passphrase undefined | string
Optional encoded Uint8Array

Returns: void

encodePkcs8

● encodePkcs8: function

Defined in types.ts:38

Type declaration

▸(passphrase?: undefined | string): Uint8Array

Parameters:

Name Type
Optional passphrase undefined | string

Returns: Uint8Array

getMeta

● getMeta: function

Defined in types.ts:39

Type declaration

▸(): KeyringPair$Meta

Returns: KeyringPair$Meta

isLocked

● isLocked: function

Defined in types.ts:40

Type declaration

▸(): boolean

Returns: boolean

lock

● lock: function

Defined in types.ts:41

Type declaration

▸(): void

Returns: void

publicKey

● publicKey: function

Defined in types.ts:42

Type declaration

▸(): Uint8Array

Returns: Uint8Array

setMeta

● setMeta: function

Defined in types.ts:43

Type declaration

▸(meta: KeyringPair$Meta): void

Parameters:

Name Type
meta KeyringPair$Meta

Returns: void

type

● type: KeyringPairType

Defined in types.ts:34

Methods

sign

▸ sign(message: Uint8Array): Uint8Array

Defined in types.ts:44

Parameters:

Name Type
message Uint8Array

Returns: Uint8Array

toJson

▸ toJson(passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:45

Parameters:

Name Type
Optional passphrase undefined | string

Returns: KeyringPair$Json

toType

▸ toType(type: KeyringPairType): KeyringPair

Defined in types.ts:46

Parameters:

Name Type
type KeyringPairType

Returns: KeyringPair

verify

▸ verify(message: Uint8Array, signature: Uint8Array): boolean

Defined in types.ts:47

Parameters:

Name Type
message Uint8Array
signature Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringPair

Properties

address

● address: function

Defined in types.ts:36

Type declaration

▸(): string

Returns: string

decodePkcs8

● decodePkcs8: function

Defined in types.ts:37

Type declaration

▸(passphrase?: undefined | string, encoded?: Uint8Array): void

Parameters:

Name Type
Optional passphrase undefined | string
Optional encoded Uint8Array

Returns: void

encodePkcs8

● encodePkcs8: function

Defined in types.ts:38

Type declaration

▸(passphrase?: undefined | string): Uint8Array

Parameters:

Name Type
Optional passphrase undefined | string

Returns: Uint8Array

getMeta

● getMeta: function

Defined in types.ts:39

Type declaration

▸(): KeyringPair$Meta

Returns: KeyringPair$Meta

isLocked

● isLocked: function

Defined in types.ts:40

Type declaration

▸(): boolean

Returns: boolean

lock

● lock: function

Defined in types.ts:41

Type declaration

▸(): void

Returns: void

publicKey

● publicKey: function

Defined in types.ts:42

Type declaration

▸(): Uint8Array

Returns: Uint8Array

setMeta

● setMeta: function

Defined in types.ts:43

Type declaration

▸(meta: KeyringPair$Meta): void

Parameters:

Name Type
meta KeyringPair$Meta

Returns: void

type

● type: KeyringPairType

Defined in types.ts:34

Methods

sign

▸ sign(message: Uint8Array): Uint8Array

Defined in types.ts:44

Parameters:

Name Type
message Uint8Array

Returns: Uint8Array

toJson

▸ toJson(passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:45

Parameters:

Name Type
Optional passphrase undefined | string

Returns: KeyringPair$Json

toType

▸ toType(type: KeyringPairType): KeyringPair

Defined in types.ts:46

Parameters:

Name Type
type KeyringPairType

Returns: KeyringPair

verify

▸ verify(message: Uint8Array, signature: Uint8Array): boolean

Defined in types.ts:47

Parameters:

Name Type
message Uint8Array
signature Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpairs.html b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpairs.html index 37c600c4f..358aa46bf 100644 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpairs.html +++ b/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpairs.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringPairs

Implemented by

Properties

add

● add: function

Defined in types.ts:51

Type declaration

▸(pair: KeyringPair): KeyringPair

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

● all: function

Defined in types.ts:52

Type declaration

▸(): Array<KeyringPair>

Returns: Array<KeyringPair>

get

● get: function

Defined in types.ts:53

Type declaration

▸(address: string | Uint8Array): KeyringPair

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

● remove: function

Defined in types.ts:54

Type declaration

▸(address: string | Uint8Array): void

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringPairs

Implemented by

Properties

add

● add: function

Defined in types.ts:51

Type declaration

▸(pair: KeyringPair): KeyringPair

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

● all: function

Defined in types.ts:52

Type declaration

▸(): Array<KeyringPair>

Returns: Array<KeyringPair>

get

● get: function

Defined in types.ts:53

Type declaration

▸(address: string | Uint8Array): KeyringPair

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

● remove: function

Defined in types.ts:54

Type declaration

▸(address: string | Uint8Array): void

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_address_decode_.html b/docs/.vuepress/dist/keyring/modules/_address_decode_.html index 9879f079f..061f6046d 100644 --- a/docs/.vuepress/dist/keyring/modules/_address_decode_.html +++ b/docs/.vuepress/dist/keyring/modules/_address_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(encoded: string | Uint8Array, prefix?: Prefix): Uint8Array

Defined in address/decode.ts:15

Parameters:

Name Type Default value
encoded string | Uint8Array -
Default value prefix Prefix defaults.prefix

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(encoded: string | Uint8Array, prefix?: Prefix): Uint8Array

Defined in address/decode.ts:15

Parameters:

Name Type Default value
encoded string | Uint8Array -
Default value prefix Prefix defaults.prefix

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_address_defaults_.html b/docs/.vuepress/dist/keyring/modules/_address_defaults_.html index 7de52eabc..b85d7b083 100644 --- a/docs/.vuepress/dist/keyring/modules/_address_defaults_.html +++ b/docs/.vuepress/dist/keyring/modules/_address_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_address_encode_.html b/docs/.vuepress/dist/keyring/modules/_address_encode_.html index 6aec233d1..ce55b0acd 100644 --- a/docs/.vuepress/dist/keyring/modules/_address_encode_.html +++ b/docs/.vuepress/dist/keyring/modules/_address_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(_key: Uint8Array | string, prefix?: Prefix): string

Defined in address/encode.ts:15

Parameters:

Name Type Default value
_key Uint8Array | string -
Default value prefix Prefix defaults.prefix

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(_key: Uint8Array | string, prefix?: Prefix): string

Defined in address/encode.ts:15

Parameters:

Name Type Default value
_key Uint8Array | string -
Default value prefix Prefix defaults.prefix

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_address_setprefix_.html b/docs/.vuepress/dist/keyring/modules/_address_setprefix_.html index cee397811..32d47f9e3 100644 --- a/docs/.vuepress/dist/keyring/modules/_address_setprefix_.html +++ b/docs/.vuepress/dist/keyring/modules/_address_setprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

setPrefix

▸ setPrefix(prefix: Prefix): void

Defined in address/setPrefix.ts:9

Parameters:

Name Type
prefix Prefix

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

setPrefix

▸ setPrefix(prefix: Prefix): void

Defined in address/setPrefix.ts:9

Parameters:

Name Type
prefix Prefix

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_address_types_.html b/docs/.vuepress/dist/keyring/modules/_address_types_.html index 53ff215cd..7aa15d883 100644 --- a/docs/.vuepress/dist/keyring/modules/_address_types_.html +++ b/docs/.vuepress/dist/keyring/modules/_address_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Prefix

Ƭ Prefix: 0 | 1 | 3 | 42 | 43 | 68 | 69

Defined in address/types.ts:5

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Prefix

Ƭ Prefix: 0 | 1 | 3 | 42 | 43 | 68 | 69

Defined in address/types.ts:5

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_decode_.html b/docs/.vuepress/dist/keyring/modules/_pair_decode_.html index 69eaeeda2..e26683b8e 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_decode_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(passphrase?: undefined | string, _encrypted?: Uint8Array | null): DecodeResult

Defined in pair/decode.ts:19

Parameters:

Name Type
Optional passphrase undefined | string
Optional _encrypted Uint8Array | null

Returns: DecodeResult

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(passphrase?: undefined | string, _encrypted?: Uint8Array | null): DecodeResult

Defined in pair/decode.ts:19

Parameters:

Name Type
Optional passphrase undefined | string
Optional _encrypted Uint8Array | null

Returns: DecodeResult

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_defaults_.html b/docs/.vuepress/dist/keyring/modules/_pair_defaults_.html index a55a8392a..ef02b4954 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_defaults_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_encode_.html b/docs/.vuepress/dist/keyring/modules/_pair_encode_.html index d790cc53e..4e5bfbc9f 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_encode_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(__namedParameters: object, passphrase?: undefined | string): Uint8Array

Defined in pair/encode.ts:12

Parameters:

Name Type
__namedParameters object
Optional passphrase undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(__namedParameters: object, passphrase?: undefined | string): Uint8Array

Defined in pair/encode.ts:12

Parameters:

Name Type
__namedParameters object
Optional passphrase undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_nobody_.html b/docs/.vuepress/dist/keyring/modules/_pair_nobody_.html index fb5adb25b..3a5ef7ca5 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_nobody_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_nobody_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

everybody

▸ everybody(): KeyringPair

Defined in pair/nobody.ts:25

Returns: KeyringPair

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

everybody

▸ everybody(): KeyringPair

Defined in pair/nobody.ts:25

Returns: KeyringPair

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html b/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html index c30a65a05..8b47b23c8 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toJson

▸ toJson(type: KeyringPairType, __namedParameters: object, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json

Defined in pair/toJson.ts:15

Parameters:

Name Type
type KeyringPairType
__namedParameters object
encoded Uint8Array
isEncrypted boolean

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toJson

▸ toJson(type: KeyringPairType, __namedParameters: object, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json

Defined in pair/toJson.ts:15

Parameters:

Name Type
type KeyringPairType
__namedParameters object
encoded Uint8Array
isEncrypted boolean

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pair_types_.html b/docs/.vuepress/dist/keyring/modules/_pair_types_.html index a39833aef..9b0b72dd6 100644 --- a/docs/.vuepress/dist/keyring/modules/_pair_types_.html +++ b/docs/.vuepress/dist/keyring/modules/_pair_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

PairInfo

Ƭ PairInfo: object

Defined in pair/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

PairInfo

Ƭ PairInfo: object

Defined in pair/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_pairs_.html b/docs/.vuepress/dist/keyring/modules/_pairs_.html index ea990c3ae..9115a8495 100644 --- a/docs/.vuepress/dist/keyring/modules/_pairs_.html +++ b/docs/.vuepress/dist/keyring/modules/_pairs_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_testing_.html b/docs/.vuepress/dist/keyring/modules/_testing_.html index f5cdd2e43..496cc3dda 100644 --- a/docs/.vuepress/dist/keyring/modules/_testing_.html +++ b/docs/.vuepress/dist/keyring/modules/_testing_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

testKeyring

▸ testKeyring(options?: KeyringOptions): KeyringInstance

Defined in testing.ts:41

name: testKeyring

summary: Create an instance of Keyring pre-populated with locked test accounts

description: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds.

Parameters:

Name Type
Optional options KeyringOptions

Returns: KeyringInstance

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

testKeyring

▸ testKeyring(options?: KeyringOptions): KeyringInstance

Defined in testing.ts:41

name: testKeyring

summary: Create an instance of Keyring pre-populated with locked test accounts

description: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds.

Parameters:

Name Type
Optional options KeyringOptions

Returns: KeyringInstance

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_testingpairs_.html b/docs/.vuepress/dist/keyring/modules/_testingpairs_.html index f5712cb4f..d6e5b0c77 100644 --- a/docs/.vuepress/dist/keyring/modules/_testingpairs_.html +++ b/docs/.vuepress/dist/keyring/modules/_testingpairs_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

testKeyringPairs

▸ testKeyringPairs(options?: KeyringOptions): TestKeyringMap

Defined in testingPairs.ts:14

Parameters:

Name Type
Optional options KeyringOptions

Returns: TestKeyringMap

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

testKeyringPairs

▸ testKeyringPairs(options?: KeyringOptions): TestKeyringMap

Defined in testingPairs.ts:14

Parameters:

Name Type
Optional options KeyringOptions

Returns: TestKeyringMap

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/keyring/modules/_types_.html b/docs/.vuepress/dist/keyring/modules/_types_.html index c0ce7f1ae..ad078962f 100644 --- a/docs/.vuepress/dist/keyring/modules/_types_.html +++ b/docs/.vuepress/dist/keyring/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

KeyringOptions

Ƭ KeyringOptions: object

Defined in types.ts:9

Type declaration

KeyringPair$Json

Ƭ KeyringPair$Json: object

Defined in types.ts:26

Type declaration

KeyringPair$JsonEncoding

Ƭ KeyringPair$JsonEncoding: object

Defined in types.ts:20

Type declaration

KeyringPair$JsonVersion

Ƭ KeyringPair$JsonVersion: "0" | "1"

Defined in types.ts:18

KeyringPair$Meta

Ƭ KeyringPair$Meta: object

Defined in types.ts:14

Type declaration

KeyringPairType

Ƭ KeyringPairType: "ed25519" | "sr25519"

Defined in types.ts:7

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

KeyringOptions

Ƭ KeyringOptions: object

Defined in types.ts:9

Type declaration

KeyringPair$Json

Ƭ KeyringPair$Json: object

Defined in types.ts:26

Type declaration

KeyringPair$JsonEncoding

Ƭ KeyringPair$JsonEncoding: object

Defined in types.ts:20

Type declaration

KeyringPair$JsonVersion

Ƭ KeyringPair$JsonVersion: "0" | "1"

Defined in types.ts:18

KeyringPair$Meta

Ƭ KeyringPair$Meta: object

Defined in types.ts:14

Type declaration

KeyringPairType

Ƭ KeyringPairType: "ed25519" | "sr25519"

Defined in types.ts:7

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/SUMMARY.html b/docs/.vuepress/dist/trie-codec/SUMMARY.html index ac5ff0cef..c613b4638 100644 --- a/docs/.vuepress/dist/trie-codec/SUMMARY.html +++ b/docs/.vuepress/dist/trie-codec/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html index f5236a75d..fd900a2c6 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Boolean

↳ BranchHeader

Properties

<Static> Boolean

● Boolean: BooleanConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540

Methods

valueOf

▸ valueOf(): boolean

Inherited from Boolean.valueOf

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531

Returns the primitive value of the specified object.

Returns: boolean

Last Updated: 2/15/2019, 1:40:51 PM
- +

Hierarchy

Boolean

↳ BranchHeader

Properties

<Static> Boolean

● Boolean: BooleanConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540

Methods

valueOf

▸ valueOf(): boolean

Inherited from Boolean.valueOf

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531

Returns the primitive value of the specified object.

Returns: boolean

Last Updated: 2/15/2019, 1:40:51 PM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.extensionheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.extensionheader.html index 81c615d12..02702ab38 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.extensionheader.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.extensionheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ ExtensionHeader

Constructors

constructor

⊕ new ExtensionHeader(input: number): ExtensionHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: ExtensionHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ ExtensionHeader

Constructors

constructor

⊕ new ExtensionHeader(input: number): ExtensionHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: ExtensionHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.leafheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.leafheader.html index 1b2cd9dab..20ccedd4d 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.leafheader.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.leafheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ LeafHeader

Constructors

constructor

⊕ new LeafHeader(input: number): LeafHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: LeafHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ LeafHeader

Constructors

constructor

⊕ new LeafHeader(input: number): LeafHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: LeafHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nibbleheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nibbleheader.html index da7701c44..3b037ee5e 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nibbleheader.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nibbleheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ ExtensionHeader

↳ LeafHeader

Constructors

constructor

⊕ new NibbleHeader(input: number): NibbleHeader

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: NibbleHeader

Methods

toNumber

▸ toNumber(): number

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ ExtensionHeader

↳ LeafHeader

Constructors

constructor

⊕ new NibbleHeader(input: number): NibbleHeader

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: NibbleHeader

Methods

toNumber

▸ toNumber(): number

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nodeheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nodeheader.html index 778d3f9dd..d2e76668a 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nodeheader.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nodeheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NodeHeader

Constructors

constructor

⊕ new NodeHeader(input?: null | Uint8Array | Array<null | Uint8Array>): NodeHeader

Defined in NodeHeader.ts:40

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: NodeHeader

Accessors

encodedLength

get encodedLength(): number

Defined in NodeHeader.ts:92

Returns: number

nodeType

get nodeType(): number

Defined in NodeHeader.ts:114

Returns: number

value

get value(): Null | BranchHeader | ExtensionHeader | LeafHeader

Defined in NodeHeader.ts:118

Returns: Null | BranchHeader | ExtensionHeader | LeafHeader

Methods

toU8a

▸ toU8a(): Uint8Array

Defined in NodeHeader.ts:122

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NodeHeader

Constructors

constructor

⊕ new NodeHeader(input?: null | Uint8Array | Array<null | Uint8Array>): NodeHeader

Defined in NodeHeader.ts:40

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: NodeHeader

Accessors

encodedLength

get encodedLength(): number

Defined in NodeHeader.ts:92

Returns: number

nodeType

get nodeType(): number

Defined in NodeHeader.ts:114

Returns: number

value

get value(): Null | BranchHeader | ExtensionHeader | LeafHeader

Defined in NodeHeader.ts:118

Returns: Null | BranchHeader | ExtensionHeader | LeafHeader

Methods

toU8a

▸ toU8a(): Uint8Array

Defined in NodeHeader.ts:122

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.null.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.null.html index 2f10de7eb..c462401b4 100644 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.null.html +++ b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.null.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Null

Last Updated: 2/13/2019, 4:33:49 PM
- +

Hierarchy

Null

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-codec/index.html b/docs/.vuepress/dist/trie-codec/index.html index dba5674cb..97a954de3 100644 --- a/docs/.vuepress/dist/trie-codec/index.html +++ b/docs/.vuepress/dist/trie-codec/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/trie-codec

Implementation of the Substrate-specific codec for a Trie

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/trie-codec

Implementation of the Substrate-specific codec for a Trie

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_constants_.html b/docs/.vuepress/dist/trie-codec/modules/_constants_.html index a767f64f1..365f33ee6 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_constants_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_constants_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Variables

<Const> BRANCH_NODE_NO_VALUE

● BRANCH_NODE_NO_VALUE: 254 = 254

Defined in constants.ts:10

<Const> BRANCH_NODE_WITH_VALUE

● BRANCH_NODE_WITH_VALUE: 255 = 255

Defined in constants.ts:11

<Const> EMPTY_TRIE

● EMPTY_TRIE: 0 = 0

Defined in constants.ts:5

<Const> EXTENSION_NODE_BIG

● EXTENSION_NODE_BIG: 253 = 253

Defined in constants.ts:9

<Const> EXTENSION_NODE_OFFSET

● EXTENSION_NODE_OFFSET: 128 = 128

Defined in constants.ts:8

<Const> EXTENSION_NODE_SMALL_MAX

● EXTENSION_NODE_SMALL_MAX: number = EXTENSION_NODE_BIG - 1

Defined in constants.ts:15

<Const> EXTENSION_NODE_THRESHOLD

● EXTENSION_NODE_THRESHOLD: number = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET

Defined in constants.ts:13

<Const> LEAF_NODE_BIG

● LEAF_NODE_BIG: 127 = 127

Defined in constants.ts:7

<Const> LEAF_NODE_OFFSET

● LEAF_NODE_OFFSET: 1 = 1

Defined in constants.ts:6

<Const> LEAF_NODE_SMALL_MAX

● LEAF_NODE_SMALL_MAX: number = LEAF_NODE_BIG - 1

Defined in constants.ts:14

<Const> LEAF_NODE_THRESHOLD

● LEAF_NODE_THRESHOLD: number = LEAF_NODE_BIG - LEAF_NODE_OFFSET

Defined in constants.ts:12

<Const> NODE_TYPE_BRANCH

● NODE_TYPE_BRANCH: 1 = 1

Defined in constants.ts:17

<Const> NODE_TYPE_EXT

● NODE_TYPE_EXT: 2 = 2

Defined in constants.ts:18

<Const> NODE_TYPE_LEAF

● NODE_TYPE_LEAF: 3 = 3

Defined in constants.ts:19

<Const> NODE_TYPE_NULL

● NODE_TYPE_NULL: 0 = 0

Defined in constants.ts:16

Last Updated: 2/26/2019, 11:08:42 AM
- +

Variables

<Const> BRANCH_NODE_NO_VALUE

● BRANCH_NODE_NO_VALUE: 254 = 254

Defined in constants.ts:10

<Const> BRANCH_NODE_WITH_VALUE

● BRANCH_NODE_WITH_VALUE: 255 = 255

Defined in constants.ts:11

<Const> EMPTY_TRIE

● EMPTY_TRIE: 0 = 0

Defined in constants.ts:5

<Const> EXTENSION_NODE_BIG

● EXTENSION_NODE_BIG: 253 = 253

Defined in constants.ts:9

<Const> EXTENSION_NODE_OFFSET

● EXTENSION_NODE_OFFSET: 128 = 128

Defined in constants.ts:8

<Const> EXTENSION_NODE_SMALL_MAX

● EXTENSION_NODE_SMALL_MAX: number = EXTENSION_NODE_BIG - 1

Defined in constants.ts:15

<Const> EXTENSION_NODE_THRESHOLD

● EXTENSION_NODE_THRESHOLD: number = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET

Defined in constants.ts:13

<Const> LEAF_NODE_BIG

● LEAF_NODE_BIG: 127 = 127

Defined in constants.ts:7

<Const> LEAF_NODE_OFFSET

● LEAF_NODE_OFFSET: 1 = 1

Defined in constants.ts:6

<Const> LEAF_NODE_SMALL_MAX

● LEAF_NODE_SMALL_MAX: number = LEAF_NODE_BIG - 1

Defined in constants.ts:14

<Const> LEAF_NODE_THRESHOLD

● LEAF_NODE_THRESHOLD: number = LEAF_NODE_BIG - LEAF_NODE_OFFSET

Defined in constants.ts:12

<Const> NODE_TYPE_BRANCH

● NODE_TYPE_BRANCH: 1 = 1

Defined in constants.ts:17

<Const> NODE_TYPE_EXT

● NODE_TYPE_EXT: 2 = 2

Defined in constants.ts:18

<Const> NODE_TYPE_LEAF

● NODE_TYPE_LEAF: 3 = 3

Defined in constants.ts:19

<Const> NODE_TYPE_NULL

● NODE_TYPE_NULL: 0 = 0

Defined in constants.ts:16

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_decode_.html b/docs/.vuepress/dist/trie-codec/modules/_decode_.html index d83c03cb0..cf53cdfbd 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_decode_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(input: null | Uint8Array): Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Defined in decode.ts:95

Parameters:

Name Type
input null | Uint8Array

Returns: Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(input: null | Uint8Array): Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Defined in decode.ts:95

Parameters:

Name Type
input null | Uint8Array

Returns: Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_encode_.html b/docs/.vuepress/dist/trie-codec/modules/_encode_.html index 081db8e1e..41187d785 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_encode_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(input?: null | Uint8Array | Array<null | Uint8Array>): Uint8Array

Defined in encode.ts:101

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(input?: null | Uint8Array | Array<null | Uint8Array>): Uint8Array

Defined in encode.ts:101

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_hashing_.html b/docs/.vuepress/dist/trie-codec/modules/_hashing_.html index 266efb168..15b39d8b0 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_hashing_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_hashing_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html index 6fd017e37..2ed61392b 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

addNibblesTerminator

▸ addNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:31

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

decodeNibbles

▸ decodeNibbles(value: null | Uint8Array): Uint8Array

Defined in nibbles.ts:52

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

encodeNibbles

▸ encodeNibbles(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:65

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

extractKey

▸ extractKey(key: null | Uint8Array): Uint8Array

Defined in nibbles.ts:15

Parameters:

Name Type
key null | Uint8Array

Returns: Uint8Array

extractNodeKey

▸ extractNodeKey(__namedParameters: [null | Uint8Array]): Uint8Array

Defined in nibbles.ts:21

Parameters:

Name Type
__namedParameters [null | Uint8Array]

Returns: Uint8Array

isNibblesTerminated

▸ isNibblesTerminated(nibbles: Uint8Array): boolean

Defined in nibbles.ts:27

Parameters:

Name Type
nibbles Uint8Array

Returns: boolean

removeNibblesTerminator

▸ removeNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:44

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

addNibblesTerminator

▸ addNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:31

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

decodeNibbles

▸ decodeNibbles(value: null | Uint8Array): Uint8Array

Defined in nibbles.ts:52

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

encodeNibbles

▸ encodeNibbles(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:65

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

extractKey

▸ extractKey(key: null | Uint8Array): Uint8Array

Defined in nibbles.ts:15

Parameters:

Name Type
key null | Uint8Array

Returns: Uint8Array

extractNodeKey

▸ extractNodeKey(__namedParameters: [null | Uint8Array]): Uint8Array

Defined in nibbles.ts:21

Parameters:

Name Type
__namedParameters [null | Uint8Array]

Returns: Uint8Array

isNibblesTerminated

▸ isNibblesTerminated(nibbles: Uint8Array): boolean

Defined in nibbles.ts:27

Parameters:

Name Type
nibbles Uint8Array

Returns: boolean

removeNibblesTerminator

▸ removeNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:44

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_nodeheader_.html b/docs/.vuepress/dist/trie-codec/modules/_nodeheader_.html index 0c7d34c6c..8c77c226e 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_nodeheader_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_nodeheader_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html index bfd428c5a..3be9a5dc2 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createBranch

▸ createBranch(value: Uint8Array | null, hasChildren: Array<boolean>): Uint8Array

Defined in stream/createBranch.ts:10

Parameters:

Name Type
value Uint8Array | null
hasChildren Array<boolean>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createBranch

▸ createBranch(value: Uint8Array | null, hasChildren: Array<boolean>): Uint8Array

Defined in stream/createBranch.ts:10

Parameters:

Name Type
value Uint8Array | null
hasChildren Array<boolean>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createempty_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createempty_.html index 870f583e8..bd68372d5 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createempty_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createempty_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createEmpty

▸ createEmpty(): Uint8Array

Defined in stream/createEmpty.ts:7

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createEmpty

▸ createEmpty(): Uint8Array

Defined in stream/createEmpty.ts:7

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html index 6a9e0f240..26f7b48b0 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createExtension

▸ createExtension(key: Uint8Array): Uint8Array

Defined in stream/createExtension.ts:7

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createExtension

▸ createExtension(key: Uint8Array): Uint8Array

Defined in stream/createExtension.ts:7

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html index 037db9fe3..80701035a 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createLeaf

▸ createLeaf(key: Uint8Array, value: Uint8Array): Uint8Array

Defined in stream/createLeaf.ts:10

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createLeaf

▸ createLeaf(key: Uint8Array, value: Uint8Array): Uint8Array

Defined in stream/createLeaf.ts:10

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createsubstream_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createsubstream_.html index e251e2c54..c2be695d9 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createsubstream_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createsubstream_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createSubstream

▸ createSubstream(value: Uint8Array): Uint8Array

Defined in stream/createSubstream.ts:8

Parameters:

Name Type
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createSubstream

▸ createSubstream(value: Uint8Array): Uint8Array

Defined in stream/createSubstream.ts:8

Parameters:

Name Type
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createvalue_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createvalue_.html index 0c1a89bff..82ff6d5c5 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createvalue_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_createvalue_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createValue

▸ createValue(value: null | Uint8Array): Uint8Array

Defined in stream/createValue.ts:9

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createValue

▸ createValue(value: null | Uint8Array): Uint8Array

Defined in stream/createValue.ts:9

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_endbranch_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_endbranch_.html index 63ecc15f9..613e596d8 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_endbranch_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_stream_endbranch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encBranch

▸ encBranch(value: Uint8Array | null): Uint8Array

Defined in stream/endBranch.ts:7

Parameters:

Name Type
value Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encBranch

▸ encBranch(value: Uint8Array | null): Uint8Array

Defined in stream/endBranch.ts:7

Parameters:

Name Type
value Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_types_.html b/docs/.vuepress/dist/trie-codec/modules/_types_.html index e44970363..c6897c688 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_types_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Codec

Ƭ Codec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Codec

Ƭ Codec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html index 932f41912..004ac5823 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

fromNibbles

▸ fromNibbles(input: Uint8Array): Uint8Array

Defined in util/fromNibbles.ts:19

name: fromNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { fromNibbles } from '@polkadot/trie-codec/util';
+

Functions

fromNibbles

▸ fromNibbles(input: Uint8Array): Uint8Array

Defined in util/fromNibbles.ts:19

name: fromNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { fromNibbles } from '@polkadot/trie-codec/util';
 
 fromNibbles(new Uint8Array([4, 1, 2, 0])); // => Uint8Array([0x41, 0x20]
-
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_util_fusenibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_util_fusenibbles_.html index a8b5a84f8..e4c485b16 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_util_fusenibbles_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_util_fusenibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

fuseNibbles

▸ fuseNibbles(nibbles: Uint8Array, isLeaf: boolean): Uint8Array

Defined in util/fuseNibbles.ts:12

Parameters:

Name Type
nibbles Uint8Array
isLeaf boolean

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

fuseNibbles

▸ fuseNibbles(nibbles: Uint8Array, isLeaf: boolean): Uint8Array

Defined in util/fuseNibbles.ts:12

Parameters:

Name Type
nibbles Uint8Array
isLeaf boolean

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_util_sharedprefixlength_.html b/docs/.vuepress/dist/trie-codec/modules/_util_sharedprefixlength_.html index 60ebc39e5..12c6cbbf3 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_util_sharedprefixlength_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_util_sharedprefixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

sharedPrefixLength

▸ sharedPrefixLength(first: Uint8Array, second: Uint8Array): number

Defined in util/sharedPrefixLength.ts:5

Parameters:

Name Type
first Uint8Array
second Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

sharedPrefixLength

▸ sharedPrefixLength(first: Uint8Array, second: Uint8Array): number

Defined in util/sharedPrefixLength.ts:5

Parameters:

Name Type
first Uint8Array
second Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-codec/modules/_util_tonibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_util_tonibbles_.html index e496d546a..4bafc7ace 100644 --- a/docs/.vuepress/dist/trie-codec/modules/_util_tonibbles_.html +++ b/docs/.vuepress/dist/trie-codec/modules/_util_tonibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

toNibbles

▸ toNibbles(input?: Uint8Array | null): Uint8Array

Defined in util/toNibbles.ts:19

name: toNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { toNibbles } from '@polkadot/trie-codec/util';
+

Functions

toNibbles

▸ toNibbles(input?: Uint8Array | null): Uint8Array

Defined in util/toNibbles.ts:19

name: toNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { toNibbles } from '@polkadot/trie-codec/util';
 
 toNibbles(new Uint8Array([0x41, 0x20]); // => Uint8Array([4, 1, 2, 0])
-
1
2
3

Parameters:

Name Type
Optional input Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional input Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/SUMMARY.html b/docs/.vuepress/dist/trie-db/SUMMARY.html index f80371413..2eee7dbac 100644 --- a/docs/.vuepress/dist/trie-db/SUMMARY.html +++ b/docs/.vuepress/dist/trie-db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html b/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html index 81650c8b1..647659436 100644 --- a/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html +++ b/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Checkpoint(rootHash: Uint8Array): Checkpoint

Defined in Checkpoint.ts:7

Parameters:

Name Type
rootHash Uint8Array

Returns: Checkpoint

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Checkpoint(rootHash: Uint8Array): Checkpoint

Defined in Checkpoint.ts:7

Parameters:

Name Type
rootHash Uint8Array

Returns: Checkpoint

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/classes/_impl_.impl.html b/docs/.vuepress/dist/trie-db/classes/_impl_.impl.html index c9ac1780b..5526ec6f2 100644 --- a/docs/.vuepress/dist/trie-db/classes/_impl_.impl.html +++ b/docs/.vuepress/dist/trie-db/classes/_impl_.impl.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/trie-db

Overview

name: Trie

summary: Re-implementation of a Patricia Trie

example: See Polkadot-JS Common Trie-DB Examples

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Impl(db: TxDb, rootHash?: Uint8Array, codec?: Codec): Impl

Overrides Checkpoint.constructor

Defined in Impl.ts:38

Parameters:

Name Type Default value
db TxDb -
Optional rootHash Uint8Array -
Default value codec Codec substrateCodec

Returns: Impl

Properties

db

● db: TxDb

Defined in Impl.ts:36

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/trie-db

Overview

name: Trie

summary: Re-implementation of a Patricia Trie

example: See Polkadot-JS Common Trie-DB Examples

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Impl(db: TxDb, rootHash?: Uint8Array, codec?: Codec): Impl

Overrides Checkpoint.constructor

Defined in Impl.ts:38

Parameters:

Name Type Default value
db TxDb -
Optional rootHash Uint8Array -
Default value codec Codec substrateCodec

Returns: Impl

Properties

db

● db: TxDb

Defined in Impl.ts:36

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/enums/_types_.nodetype.html b/docs/.vuepress/dist/trie-db/enums/_types_.nodetype.html index dffac3b0d..2f3f6138d 100644 --- a/docs/.vuepress/dist/trie-db/enums/_types_.nodetype.html +++ b/docs/.vuepress/dist/trie-db/enums/_types_.nodetype.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 3

Defined in types.ts:11

EMPTY

EMPTY: = 0

Defined in types.ts:8

EXTENSION

EXTENSION: = 2

Defined in types.ts:10

LEAF

LEAF: = 1

Defined in types.ts:9

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 3

Defined in types.ts:11

EMPTY

EMPTY: = 0

Defined in types.ts:8

EXTENSION

EXTENSION: = 2

Defined in types.ts:10

LEAF

LEAF: = 1

Defined in types.ts:9

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/index.html b/docs/.vuepress/dist/trie-db/index.html index 8427c3d34..2a112d7b4 100644 --- a/docs/.vuepress/dist/trie-db/index.html +++ b/docs/.vuepress/dist/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

@polkadot/trie-db

A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.

This is a JavaScript port of the Python Ethereum Trie with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.

Usage

Installation -

yarn add @polkadot/trie-db
+

@polkadot/trie-db

A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.

This is a JavaScript port of the Python Ethereum Trie with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.

Usage

Installation -

yarn add @polkadot/trie-db
1

Classes can be imported as follows:

import Trie from '@polkadot/trie-db'; // Default export
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/.vuepress/dist/trie-db/interfaces/_types_.triedb.html b/docs/.vuepress/dist/trie-db/interfaces/_types_.triedb.html index 36bb8a286..2efc02697 100644 --- a/docs/.vuepress/dist/trie-db/interfaces/_types_.triedb.html +++ b/docs/.vuepress/dist/trie-db/interfaces/_types_.triedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

TxDb

↳ TrieDb

Properties

db

● db: TxDb

Defined in types.ts:37

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

getRoot

▸ getRoot(): Uint8Array

Defined in types.ts:39

Returns: Uint8Array

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

setRoot

▸ setRoot(rootHash: Uint8Array): void

Defined in types.ts:40

Parameters:

Name Type
rootHash Uint8Array

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:24

Returns: number

snapshot

▸ snapshot(dest: TrieDb, fn: ProgressCb): number

Defined in types.ts:41

Parameters:

Name Type
dest TrieDb
fn ProgressCb

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TxDb.transaction

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

TxDb

↳ TrieDb

Properties

db

● db: TxDb

Defined in types.ts:37

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

getRoot

▸ getRoot(): Uint8Array

Defined in types.ts:39

Returns: Uint8Array

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

setRoot

▸ setRoot(rootHash: Uint8Array): void

Defined in types.ts:40

Parameters:

Name Type
rootHash Uint8Array

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:24

Returns: number

snapshot

▸ snapshot(dest: TrieDb, fn: ProgressCb): number

Defined in types.ts:41

Parameters:

Name Type
dest TrieDb
fn ProgressCb

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TxDb.transaction

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_checkpoint_.html b/docs/.vuepress/dist/trie-db/modules/_checkpoint_.html index 3b32c90df..237b16360 100644 --- a/docs/.vuepress/dist/trie-db/modules/_checkpoint_.html +++ b/docs/.vuepress/dist/trie-db/modules/_checkpoint_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_constants_.html b/docs/.vuepress/dist/trie-db/modules/_constants_.html index 5f098b349..97df49e3c 100644 --- a/docs/.vuepress/dist/trie-db/modules/_constants_.html +++ b/docs/.vuepress/dist/trie-db/modules/_constants_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Constants

Ƭ Constants: object

Defined in constants.ts:9

Type declaration

Functions

default

▸ default(codec: Codec): object

Defined in constants.ts:14

Parameters:

Name Type
codec Codec

Returns: object

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Constants

Ƭ Constants: object

Defined in constants.ts:9

Type declaration

Functions

default

▸ default(codec: Codec): object

Defined in constants.ts:14

Parameters:

Name Type
codec Codec

Returns: object

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_ethereumcodec_.html b/docs/.vuepress/dist/trie-db/modules/_ethereumcodec_.html index 6cccd5a2a..48b661add 100644 --- a/docs/.vuepress/dist/trie-db/modules/_ethereumcodec_.html +++ b/docs/.vuepress/dist/trie-db/modules/_ethereumcodec_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_impl_.html b/docs/.vuepress/dist/trie-db/modules/_impl_.html index d6b9fd748..4dbeb646b 100644 --- a/docs/.vuepress/dist/trie-db/modules/_impl_.html +++ b/docs/.vuepress/dist/trie-db/modules/_impl_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_types_.html b/docs/.vuepress/dist/trie-db/modules/_types_.html index 613cff8c4..e35057f83 100644 --- a/docs/.vuepress/dist/trie-db/modules/_types_.html +++ b/docs/.vuepress/dist/trie-db/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumerations

Interfaces

Type aliases

Type aliases

EncodedPath

Ƭ EncodedPath: Uint8Array | null

Defined in types.ts:28

Node

Ƭ Node: NodeEmpty | NodeNotEmpty

Defined in types.ts:34

NodeBranch

Ƭ NodeBranch: [NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty]

Defined in types.ts:20

NodeEmpty

Ƭ NodeEmpty: null

Defined in types.ts:14

NodeEncoded

Ƭ NodeEncoded: Uint8Array

Defined in types.ts:16

NodeEncodedOrEmpty

Ƭ NodeEncodedOrEmpty: NodeEncoded | NodeEmpty

Defined in types.ts:18

NodeKv

Ƭ NodeKv: [EncodedPath, NodeEncodedOrEmpty]

Defined in types.ts:30

NodeNotEmpty

Ƭ NodeNotEmpty: NodeKv | NodeBranch

Defined in types.ts:32

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumerations

Interfaces

Type aliases

Type aliases

EncodedPath

Ƭ EncodedPath: Uint8Array | null

Defined in types.ts:28

Node

Ƭ Node: NodeEmpty | NodeNotEmpty

Defined in types.ts:34

NodeBranch

Ƭ NodeBranch: [NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty]

Defined in types.ts:20

NodeEmpty

Ƭ NodeEmpty: null

Defined in types.ts:14

NodeEncoded

Ƭ NodeEncoded: Uint8Array

Defined in types.ts:16

NodeEncodedOrEmpty

Ƭ NodeEncodedOrEmpty: NodeEncoded | NodeEmpty

Defined in types.ts:18

NodeKv

Ƭ NodeKv: [EncodedPath, NodeEncodedOrEmpty]

Defined in types.ts:30

NodeNotEmpty

Ƭ NodeNotEmpty: NodeKv | NodeBranch

Defined in types.ts:32

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_util_is_.html b/docs/.vuepress/dist/trie-db/modules/_util_is_.html index 9fd367035..f2c3f67c8 100644 --- a/docs/.vuepress/dist/trie-db/modules/_util_is_.html +++ b/docs/.vuepress/dist/trie-db/modules/_util_is_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

isBranchNode

▸ isBranchNode(node: Node): boolean

Defined in util/is.ts:52

name: isBranchNode

summary: Returns true if node is an Branch 17-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isEmptyNode

▸ isEmptyNode(node: Node): boolean

Defined in util/is.ts:16

name: isEmptyNode

summary: Returns true if node is NULL

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isExtensionNode

▸ isExtensionNode(node: Node): boolean

Defined in util/is.ts:34

name: isExtensionNode

summary: Returns true if node is an Extension 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isKvNode

▸ isKvNode(node: Node): boolean

Defined in util/is.ts:25

name: isKvNode

summary: Returns true if node is not empty and contains a single key/value pair

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isLeafNode

▸ isLeafNode(node: Node): boolean

Defined in util/is.ts:43

name: isLeafNode

summary: Returns true if node is an Leaf 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

isBranchNode

▸ isBranchNode(node: Node): boolean

Defined in util/is.ts:52

name: isBranchNode

summary: Returns true if node is an Branch 17-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isEmptyNode

▸ isEmptyNode(node: Node): boolean

Defined in util/is.ts:16

name: isEmptyNode

summary: Returns true if node is NULL

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isExtensionNode

▸ isExtensionNode(node: Node): boolean

Defined in util/is.ts:34

name: isExtensionNode

summary: Returns true if node is an Extension 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isKvNode

▸ isKvNode(node: Node): boolean

Defined in util/is.ts:25

name: isKvNode

summary: Returns true if node is not empty and contains a single key/value pair

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isLeafNode

▸ isLeafNode(node: Node): boolean

Defined in util/is.ts:43

name: isLeafNode

summary: Returns true if node is an Leaf 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_util_key_.html b/docs/.vuepress/dist/trie-db/modules/_util_key_.html index 0283a41bf..5117ca3e7 100644 --- a/docs/.vuepress/dist/trie-db/modules/_util_key_.html +++ b/docs/.vuepress/dist/trie-db/modules/_util_key_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

computeExtensionKey

▸ computeExtensionKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:36

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

computeLeafKey

▸ computeLeafKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:40

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

consumeCommonPrefix

▸ consumeCommonPrefix(left: Uint8Array, right: Uint8Array): [Uint8Array, Uint8Array, Uint8Array]

Defined in util/key.ts:56

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: [Uint8Array, Uint8Array, Uint8Array]

getCommonPrefixLength

▸ getCommonPrefixLength(left: Uint8Array, right: Uint8Array): number

Defined in util/key.ts:46

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: number

keyEquals

▸ keyEquals(key: Uint8Array | null, test: Uint8Array | null): boolean

Defined in util/key.ts:10

Parameters:

Name Type
key Uint8Array | null
test Uint8Array | null

Returns: boolean

keyStartsWith

▸ keyStartsWith(key: Uint8Array | null, partial: Uint8Array | null): boolean

Defined in util/key.ts:20

Parameters:

Name Type
key Uint8Array | null
partial Uint8Array | null

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

computeExtensionKey

▸ computeExtensionKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:36

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

computeLeafKey

▸ computeLeafKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:40

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

consumeCommonPrefix

▸ consumeCommonPrefix(left: Uint8Array, right: Uint8Array): [Uint8Array, Uint8Array, Uint8Array]

Defined in util/key.ts:56

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: [Uint8Array, Uint8Array, Uint8Array]

getCommonPrefixLength

▸ getCommonPrefixLength(left: Uint8Array, right: Uint8Array): number

Defined in util/key.ts:46

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: number

keyEquals

▸ keyEquals(key: Uint8Array | null, test: Uint8Array | null): boolean

Defined in util/key.ts:10

Parameters:

Name Type
key Uint8Array | null
test Uint8Array | null

Returns: boolean

keyStartsWith

▸ keyStartsWith(key: Uint8Array | null, partial: Uint8Array | null): boolean

Defined in util/key.ts:20

Parameters:

Name Type
key Uint8Array | null
partial Uint8Array | null

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-db/modules/_util_node_.html b/docs/.vuepress/dist/trie-db/modules/_util_node_.html index 229e82fcc..0a9f9bb50 100644 --- a/docs/.vuepress/dist/trie-db/modules/_util_node_.html +++ b/docs/.vuepress/dist/trie-db/modules/_util_node_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeNode

▸ decodeNode(codec: Codec, encoded: Uint8Array | Node): Node

Defined in util/node.ts:30

Parameters:

Name Type
codec Codec
encoded Uint8Array | Node

Returns: Node

encodeNode

▸ encodeNode(codec: Codec, node: Node): Uint8Array

Defined in util/node.ts:46

Parameters:

Name Type
codec Codec
node Node

Returns: Uint8Array

getNodeType

▸ getNodeType(node: Node): NodeType

Defined in util/node.ts:13

Parameters:

Name Type
node Node

Returns: NodeType

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeNode

▸ decodeNode(codec: Codec, encoded: Uint8Array | Node): Node

Defined in util/node.ts:30

Parameters:

Name Type
codec Codec
encoded Uint8Array | Node

Returns: Node

encodeNode

▸ encodeNode(codec: Codec, node: Node): Uint8Array

Defined in util/node.ts:46

Parameters:

Name Type
codec Codec
node Node

Returns: Uint8Array

getNodeType

▸ getNodeType(node: Node): NodeType

Defined in util/node.ts:13

Parameters:

Name Type
node Node

Returns: NodeType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/SUMMARY.html b/docs/.vuepress/dist/trie-hash/SUMMARY.html index a4c3a5b1d..48adb0576 100644 --- a/docs/.vuepress/dist/trie-hash/SUMMARY.html +++ b/docs/.vuepress/dist/trie-hash/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/index.html b/docs/.vuepress/dist/trie-hash/index.html index 292e03e4b..637765dc7 100644 --- a/docs/.vuepress/dist/trie-hash/index.html +++ b/docs/.vuepress/dist/trie-hash/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

@polkadot/trie-hash

Calculate ordered and unordered Trie hashes from inputs.

Usage

Installation -

yarn add @polkadot/trie-hash
+

@polkadot/trie-hash

Calculate ordered and unordered Trie hashes from inputs.

Usage

Installation -

yarn add @polkadot/trie-hash
1

Functions can be imported as follows:

import { trieRoot } from '@polkadot/trie-hash';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/.vuepress/dist/trie-hash/modules/_buildtrie_.html b/docs/.vuepress/dist/trie-hash/modules/_buildtrie_.html index 90891fc77..30251454f 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_buildtrie_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_buildtrie_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

buildTrie

▸ buildTrie(input: Array<[Uint8Array, Uint8Array]>, cursor?: number, codec?: Codec, stream?: any): Uint8Array

Defined in buildTrie.ts:77

Parameters:

Name Type Default value
input Array<[Uint8Array, Uint8Array]> -
Default value cursor number 0
Default value codec Codec DEFAULT_CODEC
Default value stream any DEFAULT_STREAM

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

buildTrie

▸ buildTrie(input: Array<[Uint8Array, Uint8Array]>, cursor?: number, codec?: Codec, stream?: any): Uint8Array

Defined in buildTrie.ts:77

Parameters:

Name Type Default value
input Array<[Uint8Array, Uint8Array]> -
Default value cursor number 0
Default value codec Codec DEFAULT_CODEC
Default value stream any DEFAULT_STREAM

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/modules/_defaults_.html b/docs/.vuepress/dist/trie-hash/modules/_defaults_.html index f165e657f..ee6dfad81 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_defaults_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html b/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html index b949a3d35..058e7da6a 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html @@ -7,7 +7,7 @@ - + @@ -15,14 +15,14 @@ GitHub

Functions

trieRoot

▸ trieRoot(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in trieRoot.ts:29

name: trieRoot

summary: Creates a trie hash from the supplied pairs.

description: From an Array<{k: Uint8Array, v: Uint8Array}> input, calculate the triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

trieRoot

▸ trieRoot(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in trieRoot.ts:29

name: trieRoot

summary: Creates a trie hash from the supplied pairs.

description: From an Array<{k: Uint8Array, v: Uint8Array}> input, calculate the triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
 import { trieRoot } from '@polkadot/trie-hash';
 
 trieRoot([{
   k: stringToU8a('A'),
   v: stringToU8a('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
 }]); // => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html b/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html index 8c63087da..a93c8f068 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html @@ -7,7 +7,7 @@ - + @@ -15,14 +15,14 @@ GitHub

Functions

trieRootOrdered

▸ trieRootOrdered(input: Array<Uint8Array>, codec?: Codec): Uint8Array

Defined in trieRootOrdered.ts:30

name: trieRootOrdered

summary: Creates a trie hash from the supplied values.

description: From an Array<Uint8Array> input, calculate the ordered triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

trieRootOrdered

▸ trieRootOrdered(input: Array<Uint8Array>, codec?: Codec): Uint8Array

Defined in trieRootOrdered.ts:30

name: trieRootOrdered

summary: Creates a trie hash from the supplied values.

description: From an Array<Uint8Array> input, calculate the ordered triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
 import { trieRootOrdered } from '@polkadot/trie-hash';
 
 trieRootOrdered([
   stringToU8a('doe'),
   stringToU8a('reindeer')
 ]); // => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<Uint8Array> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<Uint8Array> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/modules/_types_.html b/docs/.vuepress/dist/trie-hash/modules/_types_.html index f2ac4bca0..5bc2596b8 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_types_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

TriePair

Ƭ TriePair: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

TriePair

Ƭ TriePair: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html b/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html index 4fc6a841e..9a2b44635 100644 --- a/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html +++ b/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

unhashedTrie

▸ unhashedTrie(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in unhashedTrie.ts:14

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

unhashedTrie

▸ unhashedTrie(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in unhashedTrie.ts:14

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/SUMMARY.html b/docs/.vuepress/dist/util-crypto/SUMMARY.html index 8e93dfb2c..0a5690ab8 100644 --- a/docs/.vuepress/dist/util-crypto/SUMMARY.html +++ b/docs/.vuepress/dist/util-crypto/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/index.html b/docs/.vuepress/dist/util-crypto/index.html index bb01c21d5..fbed55bce 100644 --- a/docs/.vuepress/dist/util-crypto/index.html +++ b/docs/.vuepress/dist/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/util-crypto

Various useful cyrpto utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util-crypto
+

@polkadot/util-crypto

Various useful cyrpto utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util-crypto
1

Functions can be imported as follows:

import { mnemonicGenerate } from '@polkadot/util-crypto';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← - /keyring/ + @polkadot/keyring →

- + diff --git a/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html index 607f8ab22..a8c8146e4 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2AsHex

▸ blake2AsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/asHex.ts:21

name: blake2AsHex

summary: Creates a blake2b hex from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string with the specified bitLength.

example:

import { blake2AsHex } from '@polkadot/util-crypto';
+

Functions

blake2AsHex

▸ blake2AsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/asHex.ts:21

name: blake2AsHex

summary: Creates a blake2b hex from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string with the specified bitLength.

example:

import { blake2AsHex } from '@polkadot/util-crypto';
 
 blake2AsHex('abc'); // => 0xba80a53f981c4d0d
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_blake2_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_blake2_asu8a_.html index 2069dce56..fc3ae650f 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_blake2_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2AsU8a

▸ blake2AsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array): Uint8Array

Defined in blake2/asU8a.ts:21

name: blake2AsU8a

summary: Creates a blake2b u8a from the input.

description: From a Uint8Array input, create the blake2b and return the result as a u8a with the specified bitLength.

example:

import { blake2AsU8a } from '@polkadot/util-crypto';
+

Functions

blake2AsU8a

▸ blake2AsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array): Uint8Array

Defined in blake2/asU8a.ts:21

name: blake2AsU8a

summary: Creates a blake2b u8a from the input.

description: From a Uint8Array input, create the blake2b and return the result as a u8a with the specified bitLength.

example:

import { blake2AsU8a } from '@polkadot/util-crypto';
 
 blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d]
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256
Optional key Uint8Array -

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256
Optional key Uint8Array -

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_ashex_.html index f20017ff3..2b5de65d1 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2bAsHex

▸ blake2bAsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/blake2b/asHex.ts:23

name: blake2bAsHex

summary: Creates a blake2b hex string from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string.

example:

import { blake2bAsHex } from '@polkadot/util-crypto';
+

Functions

blake2bAsHex

▸ blake2bAsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/blake2b/asHex.ts:23

name: blake2bAsHex

summary: Creates a blake2b hex string from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string.

example:

import { blake2bAsHex } from '@polkadot/util-crypto';
 
 blake2bAsHex('abc'); // => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923'
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_asu8a_.html index d486acf72..e2834d8fc 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2bAsU8a

▸ blake2bAsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array | null): Uint8Array

Defined in blake2/blake2b/asU8a.ts:22

name: blake2bAsU8a

summary: Creates a blake2b Uint8Array from the input.

description: From a Uint8Array input, create the blake2b and return the result as a Uint8Array.

example:

import { blake2bAsU8a } from '@polkadot/util-crypto';
+

Functions

blake2bAsU8a

▸ blake2bAsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array | null): Uint8Array

Defined in blake2/blake2b/asU8a.ts:22

name: blake2bAsU8a

summary: Creates a blake2b Uint8Array from the input.

description: From a Uint8Array input, create the blake2b and return the result as a Uint8Array.

example:

import { blake2bAsU8a } from '@polkadot/util-crypto';
 
 blake2bAsU8a('abc'); // => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982')
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512
Default value key Uint8Array | null null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512
Default value key Uint8Array | null null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_keccak_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_keccak_ashex_.html index 4a7c332fd..2079b7326 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_keccak_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_keccak_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

keccakAsHex

▸ keccakAsHex(value: Buffer | Uint8Array | string): string

Defined in keccak/asHex.ts:23

name: keccakAsHex

summary: Creates a keccak hex string from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a 0x prefixed hex string.

example:

import { keccakAsHex } from '@polkadot/util-crypto';
+

Functions

keccakAsHex

▸ keccakAsHex(value: Buffer | Uint8Array | string): string

Defined in keccak/asHex.ts:23

name: keccakAsHex

summary: Creates a keccak hex string from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a 0x prefixed hex string.

example:

import { keccakAsHex } from '@polkadot/util-crypto';
 
 keccakAsHex('123'); // => 0x...
-
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_keccak_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_keccak_asu8a_.html index a8da15251..3fa9c0501 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_keccak_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_keccak_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

keccakAsU8a

▸ keccakAsU8a(value: Buffer | Uint8Array | string): Uint8Array

Defined in keccak/asU8a.ts:21

name: keccakAsU8a

summary: Creates a keccak Uint8Array from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a Uint8Array.

example:

import { keccakAsU8a } from '@polkadot/util-crypto';
+

Functions

keccakAsU8a

▸ keccakAsU8a(value: Buffer | Uint8Array | string): Uint8Array

Defined in keccak/asU8a.ts:21

name: keccakAsU8a

summary: Creates a keccak Uint8Array from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a Uint8Array.

example:

import { keccakAsU8a } from '@polkadot/util-crypto';
 
 keccakAsU8a('123'); // => Uint8Array
-
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_generate_.html b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_generate_.html index a32aaf432..43f0b4916 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_generate_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_generate_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

mnemonicGenerate

▸ mnemonicGenerate(strength?: Strength): string

Defined in mnemonic/generate.ts:21

name: mnemonicGenerate

summary: Creates a valid mnemonic string using using BIP39.

example:

import { mnemonicGenerate } from '@polkadot/util-crypto';
+

Functions

mnemonicGenerate

▸ mnemonicGenerate(strength?: Strength): string

Defined in mnemonic/generate.ts:21

name: mnemonicGenerate

summary: Creates a valid mnemonic string using using BIP39.

example:

import { mnemonicGenerate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
-
1
2
3

Parameters:

Name Type
Optional strength Strength

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional strength Strength

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_tosecret_.html b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_tosecret_.html index 32ce240f1..d86a6ec36 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_tosecret_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_tosecret_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toSecret

▸ toSecret(mnemonic: string): Uint8Array

Defined in mnemonic/toSecret.ts:8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toSecret

▸ toSecret(mnemonic: string): Uint8Array

Defined in mnemonic/toSecret.ts:8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html index df6414e62..69e77e3db 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toSeed

▸ toSeed(mnemonic: string): Uint8Array

Defined in mnemonic/toSeed.ts:24

name: toSeed

summary: Creates a valid seed from a mnemonic input

example:

import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
+

Functions

toSeed

▸ toSeed(mnemonic: string): Uint8Array

Defined in mnemonic/toSeed.ts:24

name: toSeed

summary: Creates a valid seed from a mnemonic input

example:

import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
 const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
@@ -23,7 +23,7 @@
 if (isValidMnemonic) {
   console.log(`Seed generated from mnemonic: ${mnemonicToSeed(mnemonic)}`); => u8a
 }
-
1
2
3
4
5
6
7
8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_validate_.html b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_validate_.html index c415bbb24..b61e4d313 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_validate_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_validate_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

mnemonicValidate

▸ mnemonicValidate(mnemonic: string): boolean

Defined in mnemonic/validate.ts:20

name: mnemonicValidate

summary: Validates a mnemonic input using BIP39.

example:

import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
+

Functions

mnemonicValidate

▸ mnemonicValidate(mnemonic: string): boolean

Defined in mnemonic/validate.ts:20

name: mnemonicValidate

summary: Validates a mnemonic input using BIP39.

example:

import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
 const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
-
1
2
3
4

Parameters:

Name Type
mnemonic string

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
mnemonic string

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_decrypt_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_decrypt_.html index 11752ce4e..2ae4cda3a 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_decrypt_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_decrypt_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclDecrypt

▸ naclDecrypt(encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null

Defined in nacl/decrypt.ts:21

name: naclDecrypt

summary: Decrypts a message using the supplied secretKey and nonce

description: Returns an decrypted message, using the secret and nonce.

example:

import { naclDecrypt } from '@polkadot/util-crypto';
+

Functions

naclDecrypt

▸ naclDecrypt(encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null

Defined in nacl/decrypt.ts:21

name: naclDecrypt

summary: Decrypts a message using the supplied secretKey and nonce

description: Returns an decrypted message, using the secret and nonce.

example:

import { naclDecrypt } from '@polkadot/util-crypto';
 
 naclDecrypt([...], [...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type
encrypted Uint8Array
nonce Uint8Array
secret Uint8Array

Returns: Uint8Array | null

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
encrypted Uint8Array
nonce Uint8Array
secret Uint8Array

Returns: Uint8Array | null

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_encrypt_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_encrypt_.html index 00af07959..872d44211 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_encrypt_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_encrypt_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclEncrypt

▸ naclEncrypt(message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): Encrypted

Defined in nacl/encrypt.ts:28

name: naclEncrypt

summary: Encrypts a message using the supplied secretKey and nonce

description: Returns an encrypted message, using the secretKey and nonce. If the nonce was not supplied, a random value is generated.

example:

import { naclEncrypt } from '@polkadot/util-crypto';
+

Functions

naclEncrypt

▸ naclEncrypt(message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): Encrypted

Defined in nacl/encrypt.ts:28

name: naclEncrypt

summary: Encrypts a message using the supplied secretKey and nonce

description: Returns an encrypted message, using the secretKey and nonce. If the nonce was not supplied, a random value is generated.

example:

import { naclEncrypt } from '@polkadot/util-crypto';
 
 naclEncrypt([...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type Default value
message Uint8Array -
secret Uint8Array -
Default value nonce Uint8Array randomAsU8a(24)

Returns: Encrypted

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
message Uint8Array -
secret Uint8Array -
Default value nonce Uint8Array randomAsU8a(24)

Returns: Encrypted

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromrandom_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromrandom_.html index bbe0e99b3..b1cb90f8d 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromrandom_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromrandom_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromRandom

▸ naclKeypairFromRandom(): KeypairType

Defined in nacl/keypair/fromRandom.ts:23

name: naclKeypairFromRandom

summary: Creates a new public/secret keypair.

description: Returns a new generate object containing a publicKey & secretKey.

example:

import { naclKeypairFromRandom } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromRandom

▸ naclKeypairFromRandom(): KeypairType

Defined in nacl/keypair/fromRandom.ts:23

name: naclKeypairFromRandom

summary: Creates a new public/secret keypair.

description: Returns a new generate object containing a publicKey & secretKey.

example:

import { naclKeypairFromRandom } from '@polkadot/util-crypto';
 
 naclKeypairFromRandom(); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromsecret_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromsecret_.html index bc220767f..cda47bdd5 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromsecret_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromsecret_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromSecret

▸ naclKeypairFromSecret(secret: Uint8Array): KeypairType

Defined in nacl/keypair/fromSecret.ts:23

name: naclKeypairFromSecret

summary: Creates a new public/secret keypair from a secret.

description: Returns a object containing a publicKey & secretKey generated from the supplied secret.

example:

import { naclKeypairFromSecret } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromSecret

▸ naclKeypairFromSecret(secret: Uint8Array): KeypairType

Defined in nacl/keypair/fromSecret.ts:23

name: naclKeypairFromSecret

summary: Creates a new public/secret keypair from a secret.

description: Returns a object containing a publicKey & secretKey generated from the supplied secret.

example:

import { naclKeypairFromSecret } from '@polkadot/util-crypto';
 
 naclKeypairFromSecret(...); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
secret Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
secret Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromseed_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromseed_.html index 8a7a75f3a..710105b46 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromseed_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromseed_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromSeed

▸ naclKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in nacl/keypair/fromSeed.ts:23

name: naclKeypairFromSeed

summary: Creates a new public/secret keypair from a seed.

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

example:

import { naclKeypairFromSeed } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromSeed

▸ naclKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in nacl/keypair/fromSeed.ts:23

name: naclKeypairFromSeed

summary: Creates a new public/secret keypair from a seed.

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

example:

import { naclKeypairFromSeed } from '@polkadot/util-crypto';
 
 naclKeypairFromSeed(...); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromstring_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromstring_.html index faec91aa1..2d0db232e 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromstring_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromstring_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromString

▸ naclKeypairFromString(value: string): KeypairType

Defined in nacl/keypair/fromString.ts:26

name: naclKeypairFromString

summary: Creates a new public/secret keypair from a string.

description: Returns a object containing a publicKey & secretKey generated from the supplied string. The string is hashed and the value used as the input seed.

example:

import { naclKeypairFromString } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromString

▸ naclKeypairFromString(value: string): KeypairType

Defined in nacl/keypair/fromString.ts:26

name: naclKeypairFromString

summary: Creates a new public/secret keypair from a string.

description: Returns a object containing a publicKey & secretKey generated from the supplied string. The string is hashed and the value used as the input seed.

example:

import { naclKeypairFromString } from '@polkadot/util-crypto';
 
 naclKeypairFromString('test'); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
value string

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value string

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_sign_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_sign_.html index 08b967594..16deaf772 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_sign_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_sign_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclSign

▸ naclSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in nacl/sign.ts:24

name: naclSign

summary: Signs a message using the supplied secretKey

description: Returns message signature of message, using the secretKey.

example:

import { naclSign } from '@polkadot/util-crypto';
+

Functions

naclSign

▸ naclSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in nacl/sign.ts:24

name: naclSign

summary: Signs a message using the supplied secretKey

description: Returns message signature of message, using the secretKey.

example:

import { naclSign } from '@polkadot/util-crypto';
 
 naclSign([...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_nacl_verify_.html b/docs/.vuepress/dist/util-crypto/modules/_nacl_verify_.html index b629a2c65..d08cac2a8 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_verify_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_nacl_verify_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclVerify

▸ naclVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in nacl/verify.ts:21

name: naclSign

summary: Verifies the signature on the supplied message.

description: Verifies the signature on message with the supplied plublicKey. Returns true on sucess, false otherwise.

example:

import { naclVerify } from '@polkadot/util-crypto';
+

Functions

naclVerify

▸ naclVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in nacl/verify.ts:21

name: naclSign

summary: Verifies the signature on the supplied message.

description: Verifies the signature on message with the supplied plublicKey. Returns true on sucess, false otherwise.

example:

import { naclVerify } from '@polkadot/util-crypto';
 
 naclVerify([...], [...], [...]); // => true/false
-
1
2
3

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_random_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_random_ashex_.html index 704ce2ffb..84d48f9c2 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_random_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_random_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsHex

▸ randomAsHex(length?: number): string

Defined in random/asHex.ts:23

name: randomAsHex

summary: Creates a hex string filled with random bytes.

description: Returns a hex string with the specified (optional) length filled with random bytes.

example:

import { randomAsHex } from '@polkadot/util-crypto';
+

Functions

randomAsHex

▸ randomAsHex(length?: number): string

Defined in random/asHex.ts:23

name: randomAsHex

summary: Creates a hex string filled with random bytes.

description: Returns a hex string with the specified (optional) length filled with random bytes.

example:

import { randomAsHex } from '@polkadot/util-crypto';
 
 randomAsHex(); // => 0x...
-
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_random_asnumber_.html b/docs/.vuepress/dist/util-crypto/modules/_random_asnumber_.html index 2aa2cf2e3..8d59ee36d 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_random_asnumber_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_random_asnumber_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsNumber

▸ randomAsNumber(): number

Defined in random/asNumber.ts:26

name: randomAsNumber

summary: Creates a random number from random bytes.

description: Returns a random number generated from the secure bytes.

example:

import { randomAsNumber } from '@polkadot/util-crypto';
+

Functions

randomAsNumber

▸ randomAsNumber(): number

Defined in random/asNumber.ts:26

name: randomAsNumber

summary: Creates a random number from random bytes.

description: Returns a random number generated from the secure bytes.

example:

import { randomAsNumber } from '@polkadot/util-crypto';
 
 randomAsNumber(); // => <random number>
-
1
2
3

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_random_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_random_asu8a_.html index 086ebd5e9..6765c98d1 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_random_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_random_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsU8a

▸ randomAsU8a(length?: number): Uint8Array

Defined in random/asU8a.ts:21

name: randomAsU8a

summary: Creates a Uint8Array filled with random bytes.

description: Returns a Uint8Array with the specified (optional) length filled with random bytes.

example:

import { randomAsU8a } from '@polkadot/util-crypto';
+

Functions

randomAsU8a

▸ randomAsU8a(length?: number): Uint8Array

Defined in random/asU8a.ts:21

name: randomAsU8a

summary: Creates a Uint8Array filled with random bytes.

description: Returns a Uint8Array with the specified (optional) length filled with random bytes.

example:

import { randomAsU8a } from '@polkadot/util-crypto';
 
 randomAsU8a(); // => Uint8Array([...])
-
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_keypair_fromseed_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_keypair_fromseed_.html index a58c661df..ab8da608d 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_keypair_fromseed_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_keypair_fromseed_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelKeypairFromSeed

▸ schnorrkelKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in schnorrkel/keypair/fromSeed.ts:16

name: schnorrkelKeypairFromSeed

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelKeypairFromSeed

▸ schnorrkelKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in schnorrkel/keypair/fromSeed.ts:16

name: schnorrkelKeypairFromSeed

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_ready_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_ready_.html index a7c5a67f4..38ae800e0 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_ready_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_ready_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelIsReady

▸ schnorrkelIsReady(): boolean

Defined in schnorrkel/ready.ts:11

Returns: boolean

schnorrkelWaitReady

▸ schnorrkelWaitReady(): Promise<boolean>

Defined in schnorrkel/ready.ts:7

Returns: Promise<boolean>

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelIsReady

▸ schnorrkelIsReady(): boolean

Defined in schnorrkel/ready.ts:11

Returns: boolean

schnorrkelWaitReady

▸ schnorrkelWaitReady(): Promise<boolean>

Defined in schnorrkel/ready.ts:7

Returns: Promise<boolean>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_sign_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_sign_.html index 0123227f7..043468d26 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_sign_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_sign_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelSign

▸ schnorrkelSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in schnorrkel/sign.ts:15

name: schnorrkelSign

description: Returns message signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelSign

▸ schnorrkelSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in schnorrkel/sign.ts:15

name: schnorrkelSign

description: Returns message signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_test_polyfill_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_test_polyfill_.html index 13938e1ee..ce831befd 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_test_polyfill_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_test_polyfill_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/19/2019, 3:11:49 PM
- +
Last Updated: 2/19/2019, 3:11:49 PM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html index 1dd030527..0606f0405 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelVerify

▸ schnorrkelVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in schnorrkel/verify.ts:11

name: schnorrkelVerify

description: Verifies the signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelVerify

▸ schnorrkelVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in schnorrkel/verify.ts:11

name: schnorrkelVerify

description: Verifies the signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_secp256k1_recover_.html b/docs/.vuepress/dist/util-crypto/modules/_secp256k1_recover_.html index fc0b06a55..e2c30e4cb 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_secp256k1_recover_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_secp256k1_recover_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

secp256k1Recover

▸ secp256k1Recover(_message: Uint8Array, _signature: Uint8Array, recovery: number): Uint8Array

Defined in secp256k1/recover.ts:12

name: secp256k1Recover

description: Recovers a publicKey from the supplied signature

Parameters:

Name Type
_message Uint8Array
_signature Uint8Array
recovery number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

secp256k1Recover

▸ secp256k1Recover(_message: Uint8Array, _signature: Uint8Array, recovery: number): Uint8Array

Defined in secp256k1/recover.ts:12

name: secp256k1Recover

description: Recovers a publicKey from the supplied signature

Parameters:

Name Type
_message Uint8Array
_signature Uint8Array
recovery number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_sha512_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_sha512_asu8a_.html index e41b1d2bf..d3ff5d071 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_sha512_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_sha512_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

sha512AsU8a

▸ sha512AsU8a(data: Uint8Array): Uint8Array

Defined in sha512/asU8a.ts:21

name: sha512AsU8a

summary: Creates sha-512 hash of the input.

description: Returns a sha-512 Uint8Array from the supplied data.

example:

import { sha512AsU8a } from '@polkadot/util-crypto';
+

Functions

sha512AsU8a

▸ sha512AsU8a(data: Uint8Array): Uint8Array

Defined in sha512/asU8a.ts:21

name: sha512AsU8a

summary: Creates sha-512 hash of the input.

description: Returns a sha-512 Uint8Array from the supplied data.

example:

import { sha512AsU8a } from '@polkadot/util-crypto';
 
 sha512AsU8a(Uint8Array.from([...])); // => Uint8Array([...])
-
1
2
3

Parameters:

Name Type
data Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_types_.html b/docs/.vuepress/dist/util-crypto/modules/_types_.html index 89ca74e1e..7fcbb4eef 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_types_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

KeypairType

Ƭ KeypairType: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

KeypairType

Ƭ KeypairType: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html index 21524eb20..9afeee0a8 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhashAsHex

▸ xxhashAsHex(data: Buffer | Uint8Array | string, bitLength?: number): string

Defined in xxhash/asHex.ts:23

name: xxhashAsHex

summary: Creates a xxhash64 hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a hex string with the specified bitLength.

example:

import { xxhashAsHex } from '@polkadot/util-crypto';
+

Functions

xxhashAsHex

▸ xxhashAsHex(data: Buffer | Uint8Array | string, bitLength?: number): string

Defined in xxhash/asHex.ts:23

name: xxhashAsHex

summary: Creates a xxhash64 hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a hex string with the specified bitLength.

example:

import { xxhashAsHex } from '@polkadot/util-crypto';
 
 xxhashAsHex('abc'); // => 0x44bc2cf5ad770999
-
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_asu8a_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_asu8a_.html index d61a870d4..bec694682 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_asu8a_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhashAsU8a

▸ xxhashAsU8a(data: Buffer | Uint8Array | string, bitLength?: number): Uint8Array

Defined in xxhash/asU8a.ts:21

name: xxhashAsU8a

summary: Creates a xxhash64 u8a from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a Uint8Array with the specified bitLength.

example:

import { xxhashAsU8a } from '@polkadot/util-crypto';
+

Functions

xxhashAsU8a

▸ xxhashAsU8a(data: Buffer | Uint8Array | string, bitLength?: number): Uint8Array

Defined in xxhash/asU8a.ts:21

name: xxhashAsU8a

summary: Creates a xxhash64 u8a from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a Uint8Array with the specified bitLength.

example:

import { xxhashAsU8a } from '@polkadot/util-crypto';
 
 xxhashAsU8a('abc'); // => 0x44bc2cf5ad770999
-
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asbn_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asbn_.html index b2cfb53e8..46a56504f 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asbn_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asbn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsBn

▸ xxhash64AsBn(data: Buffer | Uint8Array | string, seed: number): BN

Defined in xxhash/xxhash64/asBn.ts:23

name: xxhash64AsBn

summary: Creates a xxhash BN from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a BN.

example:

import { xxhash64AsNumber } from '@polkadot/util-crypto';
+

Functions

xxhash64AsBn

▸ xxhash64AsBn(data: Buffer | Uint8Array | string, seed: number): BN

Defined in xxhash/xxhash64/asBn.ts:23

name: xxhash64AsBn

summary: Creates a xxhash BN from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a BN.

example:

import { xxhash64AsNumber } from '@polkadot/util-crypto';
 
 xxhash64AsBn('abcd', 0xabcd)); // => new BN(0xe29f70f8b8c96df7)
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_ashex_.html index 271e777c0..06044e7ba 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_ashex_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsHex

▸ xxhash64AsHex(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asHex.ts:23

name: xxhash64AsHex

summary: Creates a xxhash hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex string.

example:

import { xxhash64AsHex } from '@polkadot/util-crypto';
+

Functions

xxhash64AsHex

▸ xxhash64AsHex(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asHex.ts:23

name: xxhash64AsHex

summary: Creates a xxhash hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex string.

example:

import { xxhash64AsHex } from '@polkadot/util-crypto';
 
 xxhash64AsHex('abcd', 0xabcd)); // => 0xe29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asraw_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asraw_.html index 2aebb59d1..b5cffcbf0 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asraw_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asraw_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsRaw

▸ xxhash64AsRaw(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asRaw.ts:21

name: xxhash64AsRaw

summary: Creates a xxhash non-prefixed hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a non-prefixed hex string.

example:

import { xxhash64AsRaw } from '@polkadot/util-crypto';
+

Functions

xxhash64AsRaw

▸ xxhash64AsRaw(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asRaw.ts:21

name: xxhash64AsRaw

summary: Creates a xxhash non-prefixed hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a non-prefixed hex string.

example:

import { xxhash64AsRaw } from '@polkadot/util-crypto';
 
 xxhash64AsRaw('abcd', 0xabcd)); // => e29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asvalue_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asvalue_.html index 5f02f0b9f..c48114690 100644 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asvalue_.html +++ b/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asvalue_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsValue

▸ xxhash64AsValue(data: Buffer | Uint8Array | string, seed: number): number

Defined in xxhash/xxhash64/asValue.ts:22

name: xxhash64AsValue

summary: Creates a hex number from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex number

example:

import { xxhash64AsValue } from '@polkadot/util-crypto';
+

Functions

xxhash64AsValue

▸ xxhash64AsValue(data: Buffer | Uint8Array | string, seed: number): number

Defined in xxhash/xxhash64/asValue.ts:22

name: xxhash64AsValue

summary: Creates a hex number from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex number

example:

import { xxhash64AsValue } from '@polkadot/util-crypto';
 
 xxhash64AsValue('abcd', 0xabcd)); // => e29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/SUMMARY.html b/docs/.vuepress/dist/util-rlp/SUMMARY.html index ad112de68..6f7061e18 100644 --- a/docs/.vuepress/dist/util-rlp/SUMMARY.html +++ b/docs/.vuepress/dist/util-rlp/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/index.html b/docs/.vuepress/dist/util-rlp/index.html index b3fd33b4b..4e822902b 100644 --- a/docs/.vuepress/dist/util-rlp/index.html +++ b/docs/.vuepress/dist/util-rlp/index.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

@polkadot/util-rlp

Utility methods for encoding and decoding Ethereum RLP structures. This is port adapted from the original EthereumJS RLP implementation to cater for Uint8Array outputs (instead of Buffer) in addition to typings.

Usage

Installation -

yarn add @polkadot/util-rlp
+

@polkadot/util-rlp

Utility methods for encoding and decoding Ethereum RLP structures. This is port adapted from the original EthereumJS RLP implementation to cater for Uint8Array outputs (instead of Buffer) in addition to typings.

Usage

Installation -

yarn add @polkadot/util-rlp
1

Functions can be imported as follows:

import { decode } from '@polkadot/util-rlp';
 import { encode } from '@polkadot/util-rlp';
1
2

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/.vuepress/dist/util-rlp/modules/_decode_.html b/docs/.vuepress/dist/util-rlp/modules/_decode_.html index 07c4424d2..d3b1f3d03 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decode_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html index 8b7832009..3f0d347ab 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(input: Uint8Array): DecodeOutput

Defined in decoder/decode.ts:28

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(input: Uint8Array): DecodeOutput

Defined in decoder/decode.ts:28

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html index bdcd49cab..f124980f4 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeListLong

▸ decodeListLong(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listLong.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeListLong

▸ decodeListLong(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listLong.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html index de5dde7f9..da1f5e67a 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeListShort

▸ decodeListShort(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listShort.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeListShort

▸ decodeListShort(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listShort.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html index 6fc9ebaa1..b661a269b 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeNumber

▸ decodeNumber(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/number.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeNumber

▸ decodeNumber(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/number.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html index 3a34d1822..ad8df1ad1 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

safeParseInt

▸ safeParseInt(input: Uint8Array): number

Defined in decoder/safeParseInt.ts:7

Parameters:

Name Type
input Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

safeParseInt

▸ safeParseInt(input: Uint8Array): number

Defined in decoder/safeParseInt.ts:7

Parameters:

Name Type
input Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html index 4a126ca8f..f92071561 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeSingle

▸ decodeSingle(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/single.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeSingle

▸ decodeSingle(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/single.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html index 3f4b030ef..358c6deb1 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeString

▸ decodeString(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/string.ts:9

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeString

▸ decodeString(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/string.ts:9

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html index eea812f55..34fe24590 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

DecodeFunc

Ƭ DecodeFunc: function

Defined in decoder/types.ts:10

Type declaration

▸(input: Uint8Array): DecodeOutput

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

DecodeOutput

Ƭ DecodeOutput: object

Defined in decoder/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

DecodeFunc

Ƭ DecodeFunc: function

Defined in decoder/types.ts:10

Type declaration

▸(input: Uint8Array): DecodeOutput

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

DecodeOutput

Ƭ DecodeOutput: object

Defined in decoder/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encode_.html b/docs/.vuepress/dist/util-rlp/modules/_encode_.html index c1fdadcd5..f7eb499c4 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encode_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html index d1339631e..bce44d88c 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeArray

▸ encodeArray(encoder: EncodeFunc, input: any): Uint8Array

Defined in encoder/array.ts:11

Parameters:

Name Type
encoder EncodeFunc
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeArray

▸ encodeArray(encoder: EncodeFunc, input: any): Uint8Array

Defined in encoder/array.ts:11

Parameters:

Name Type
encoder EncodeFunc
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html index 65aa71630..b33d19193 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeLength

▸ encodeLength(length: number, offset: number): Uint8Array

Defined in encoder/length.ts:7

Parameters:

Name Type
length number
offset number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeLength

▸ encodeLength(length: number, offset: number): Uint8Array

Defined in encoder/length.ts:7

Parameters:

Name Type
length number
offset number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_tou8a_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_tou8a_.html index 29a1961b0..c72a9af22 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_tou8a_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encoder_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toU8a

▸ toU8a(value?: any): Uint8Array

Defined in encoder/toU8a.ts:39

Parameters:

Name Type
Optional value any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toU8a

▸ toU8a(value?: any): Uint8Array

Defined in encoder/toU8a.ts:39

Parameters:

Name Type
Optional value any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html index 43df5734f..4b7b94c39 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

EncodeFunc

Ƭ EncodeFunc: function

Defined in encoder/types.ts:5

Type declaration

▸(input: any): Uint8Array

Parameters:

Name Type
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

EncodeFunc

Ƭ EncodeFunc: function

Defined in encoder/types.ts:5

Type declaration

▸(input: any): Uint8Array

Parameters:

Name Type
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_u8a_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_u8a_.html index 99a7f384c..ceeeae60c 100644 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_u8a_.html +++ b/docs/.vuepress/dist/util-rlp/modules/_encoder_u8a_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeU8a

▸ encodeU8a(encoder: EncodeFunc, input: Uint8Array): Uint8Array

Defined in encoder/u8a.ts:11

Parameters:

Name Type
encoder EncodeFunc
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeU8a

▸ encodeU8a(encoder: EncodeFunc, input: Uint8Array): Uint8Array

Defined in encoder/u8a.ts:11

Parameters:

Name Type
encoder EncodeFunc
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/SUMMARY.html b/docs/.vuepress/dist/util/SUMMARY.html index d1c99f51f..2fa916e8b 100644 --- a/docs/.vuepress/dist/util/SUMMARY.html +++ b/docs/.vuepress/dist/util/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html b/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html index f90294636..37a2a19c4 100644 --- a/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html +++ b/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

name: ExtError

summary: Extension to the basic JS Error.

description: The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal stack, message, the numeric code and data (any types) parameters are available on the object.

example:

const { ExtError } from '@polkadot/util');
+

name: ExtError

summary: Extension to the basic JS Error.

description: The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal stack, message, the numeric code and data (any types) parameters are available on the object.

example:

const { ExtError } from '@polkadot/util');
 
 throw new ExtError('some message', ExtError.CODES.METHOD_NOT_FOUND); // => error.code = -32601
-
1
2
3

Hierarchy

Error

↳ ExtError

Implements

Constructors

constructor

⊕ new ExtError(message?: string, code?: number, data?: any): ExtError

Defined in ext/error.ts:43

Parameters:

Name Type Default value
Default value message string ""
Default value code number UNKNOWN
Optional data any -

Returns: ExtError

Properties

code

● code: number

Implementation of ExtErrorInterface.code

Defined in ext/error.ts:35

data

● data: any

Implementation of ExtErrorInterface.data

Defined in ext/error.ts:37

message

● message: string

Implementation of ExtErrorInterface.message

Overrides Error.message

Defined in ext/error.ts:39

name

● name: string

Overrides Error.name

Defined in ext/error.ts:41

stack

● stack: string

Implementation of ExtErrorInterface.stack

Overrides Error.stack

Defined in ext/error.ts:43

<Static> Error

● Error: ErrorConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984

Object literals

<Static> CODES

CODES: object

Defined in ext/error.ts:60

ASSERT

● ASSERT: number = -90009

Defined in ext/error.ts:61

INVALID_JSONRPC

● INVALID_JSONRPC: number = -99998

Defined in ext/error.ts:63

METHOD_NOT_FOUND

● METHOD_NOT_FOUND: number = -32601

Defined in ext/error.ts:64

UNKNOWN

● UNKNOWN: number

Defined in ext/error.ts:62

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Hierarchy

Error

↳ ExtError

Implements

Constructors

constructor

⊕ new ExtError(message?: string, code?: number, data?: any): ExtError

Defined in ext/error.ts:43

Parameters:

Name Type Default value
Default value message string ""
Default value code number UNKNOWN
Optional data any -

Returns: ExtError

Properties

code

● code: number

Implementation of ExtErrorInterface.code

Defined in ext/error.ts:35

data

● data: any

Implementation of ExtErrorInterface.data

Defined in ext/error.ts:37

message

● message: string

Implementation of ExtErrorInterface.message

Overrides Error.message

Defined in ext/error.ts:39

name

● name: string

Overrides Error.name

Defined in ext/error.ts:41

stack

● stack: string

Implementation of ExtErrorInterface.stack

Overrides Error.stack

Defined in ext/error.ts:43

<Static> Error

● Error: ErrorConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984

Object literals

<Static> CODES

CODES: object

Defined in ext/error.ts:60

ASSERT

● ASSERT: number = -90009

Defined in ext/error.ts:61

INVALID_JSONRPC

● INVALID_JSONRPC: number = -99998

Defined in ext/error.ts:63

METHOD_NOT_FOUND

● METHOD_NOT_FOUND: number = -32601

Defined in ext/error.ts:64

UNKNOWN

● UNKNOWN: number

Defined in ext/error.ts:62

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/index.html b/docs/.vuepress/dist/util/index.html index 1a6f0433e..66ccca299 100644 --- a/docs/.vuepress/dist/util/index.html +++ b/docs/.vuepress/dist/util/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/util

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util
+

@polkadot/util

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util
1

Functions can be imported directly from the package, e.g.

import { isHex } from '@polkadot/util';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← - /util-crypto/ + @polkadot/util-crypto →

- + diff --git a/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html b/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html index ee1637803..f433a841b 100644 --- a/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html +++ b/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

ExtErrorInterface

Implemented by

Properties

code

● code: number

Defined in types.ts:6

data

● data: any

Defined in types.ts:7

message

● message: string

Defined in types.ts:8

stack

● stack: string

Defined in types.ts:9

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

ExtErrorInterface

Implemented by

Properties

code

● code: number

Defined in types.ts:6

data

● data: any

Defined in types.ts:7

message

● message: string

Defined in types.ts:8

stack

● stack: string

Defined in types.ts:9

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/interfaces/_types_.tobnoptions.html b/docs/.vuepress/dist/util/interfaces/_types_.tobnoptions.html index c418c3a34..2c2acb23a 100644 --- a/docs/.vuepress/dist/util/interfaces/_types_.tobnoptions.html +++ b/docs/.vuepress/dist/util/interfaces/_types_.tobnoptions.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

ToBnOptions

Properties

<Optional> isLe

● isLe: undefined | false | true

Defined in types.ts:24

<Optional> isNegative

● isNegative: undefined | false | true

Defined in types.ts:25

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

ToBnOptions

Properties

<Optional> isLe

● isLe: undefined | false | true

Defined in types.ts:24

<Optional> isNegative

● isNegative: undefined | false | true

Defined in types.ts:25

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_array_filter_.html b/docs/.vuepress/dist/util/modules/_array_filter_.html index c700facab..58c8dd9c9 100644 --- a/docs/.vuepress/dist/util/modules/_array_filter_.html +++ b/docs/.vuepress/dist/util/modules/_array_filter_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

arrayFilter

▸ arrayFilter(array: Array<any>, allowNulls?: boolean): Array<any>

Defined in array/filter.ts:23

name: arrayFilter

summary: Filters undefined and (optionally) null values from an array

description: Returns a new array with all undefined values removed. Optionally, when allowNulls = false, it removes the null values as well

example:

import { arrayFilter } from '@polkadot/util';
+

Functions

arrayFilter

▸ arrayFilter(array: Array<any>, allowNulls?: boolean): Array<any>

Defined in array/filter.ts:23

name: arrayFilter

summary: Filters undefined and (optionally) null values from an array

description: Returns a new array with all undefined values removed. Optionally, when allowNulls = false, it removes the null values as well

example:

import { arrayFilter } from '@polkadot/util';
 
 arrayFilter([0, void 0, true, null, false, '']); // [0, true, null, false, '']
 arrayFilter([0, void 0, true, null, false, ''], false); // [0, true, false, '']
-
1
2
3
4

Parameters:

Name Type Default value
array Array<any> -
Default value allowNulls boolean true

Returns: Array<any>

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
array Array<any> -
Default value allowNulls boolean true

Returns: Array<any>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_assert_.html b/docs/.vuepress/dist/util/modules/_assert_.html index 488c76a58..e65b69d62 100644 --- a/docs/.vuepress/dist/util/modules/_assert_.html +++ b/docs/.vuepress/dist/util/modules/_assert_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

assert

▸ assert<T>(test: Falsy | T, message: string | MessageFn, code?: number, data?: any): boolean

Defined in assert.ts:28

name: assert

summary: Checks for a valid test, if not ExtError is thrown.

description: Checks that test is a truthy value. If value is falsy (null, undefined, false, ...), it throws an ExtError with the supplied message and an optional code and data. When test passes, true is returned.

example:

const { assert } from '@polkadot/util';
+

Functions

assert

▸ assert<T>(test: Falsy | T, message: string | MessageFn, code?: number, data?: any): boolean

Defined in assert.ts:28

name: assert

summary: Checks for a valid test, if not ExtError is thrown.

description: Checks that test is a truthy value. If value is falsy (null, undefined, false, ...), it throws an ExtError with the supplied message and an optional code and data. When test passes, true is returned.

example:

const { assert } from '@polkadot/util';
 
 assert(true, 'True should be true'); // true returned
 assert(false, 'False should not be true'); // ExtError thrown
 assert(false, () => 'message'); // ExtError with 'message'
-
1
2
3
4
5

Type parameters:

T

Parameters:

Name Type Default value
test Falsy | T -
message string | MessageFn -
Default value code number ExtError.CODES.ASSERT
Optional data any -

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Type parameters:

T

Parameters:

Name Type Default value
test Falsy | T -
message string | MessageFn -
Default value code number ExtError.CODES.ASSERT
Optional data any -

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_bn_fromhex_.html b/docs/.vuepress/dist/util/modules/_bn_fromhex_.html index d62a852ed..c15a69303 100644 --- a/docs/.vuepress/dist/util/modules/_bn_fromhex_.html +++ b/docs/.vuepress/dist/util/modules/_bn_fromhex_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_bn_tobn_.html b/docs/.vuepress/dist/util/modules/_bn_tobn_.html index f388f1f87..17bac4499 100644 --- a/docs/.vuepress/dist/util/modules/_bn_tobn_.html +++ b/docs/.vuepress/dist/util/modules/_bn_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

bnToBn

▸ bnToBn(value?: BN | number | null): BN

Defined in bn/toBn.ts:23

name: bnToBn

summary: Creates a BN value from a BN.js bignumber or number input.

description: null inputs returns a 0x0 result, BN values returns the value, numnbers returns a BN representation.

example:

import BN from 'bn.js';
+

Functions

bnToBn

▸ bnToBn(value?: BN | number | null): BN

Defined in bn/toBn.ts:23

name: bnToBn

summary: Creates a BN value from a BN.js bignumber or number input.

description: null inputs returns a 0x0 result, BN values returns the value, numnbers returns a BN representation.

example:

import BN from 'bn.js';
 import { bnToBn } from '@polkadot/util';
 
 bnToBn(0x1234); // => BN(0x1234)
 bnToBn(new BN(0x1234)); // => BN(0x1234)
-
1
2
3
4
5

Parameters:

Name Type
Optional value BN | number | null

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type
Optional value BN | number | null

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_bn_tohex_.html b/docs/.vuepress/dist/util/modules/_bn_tohex_.html index 9f54828e8..c48a5bb08 100644 --- a/docs/.vuepress/dist/util/modules/_bn_tohex_.html +++ b/docs/.vuepress/dist/util/modules/_bn_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

bnToHex

▸ bnToHex(value?: BN | number | null, options?: number | Options): string

Defined in bn/toHex.ts:33

name: bnToHex

summary: Creates a hex value from a BN.js bignumber object.

description: null inputs returns a 0x result, BN values return the actual value as a 0x prefixed hex value. Anything that is not a BN object throws an error. With bitLength set, it fixes the number to the specified length.

example:

import BN from 'bn.js';
+

Functions

bnToHex

▸ bnToHex(value?: BN | number | null, options?: number | Options): string

Defined in bn/toHex.ts:33

name: bnToHex

summary: Creates a hex value from a BN.js bignumber object.

description: null inputs returns a 0x result, BN values return the actual value as a 0x prefixed hex value. Anything that is not a BN object throws an error. With bitLength set, it fixes the number to the specified length.

example:

import BN from 'bn.js';
 import { bnToHex } from '@polkadot/util';
 
 bnToHex(new BN(0x123456)); // => '0x123456'
-
1
2
3
4

Parameters:

Name Type Default value
Optional value BN | number | null -
Default value options number | Options { bitLength: -1, isLe: false, isNegative: false }

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional value BN | number | null -
Default value options number | Options { bitLength: -1, isLe: false, isNegative: false }

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_bn_tou8a_.html b/docs/.vuepress/dist/util/modules/_bn_tou8a_.html index 651a9f74a..6127790b9 100644 --- a/docs/.vuepress/dist/util/modules/_bn_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_bn_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

bnToU8a

▸ bnToU8a(value: BN | number | null, options?: Options): Uint8Array

▸ bnToU8a(value: BN | number | null, bitLength?: undefined | number, isLe?: undefined | false | true): Uint8Array

Defined in bn/toU8a.ts:29

name: bnToU8a

summary: Creates a Uint8Array object from a BN.

description: null/undefined/NaN inputs returns an empty Uint8Array result. BN input values return the actual bytes value converted to a Uint8Array. Optionally convert using little-endian format if isLE is set.

example:

import { bnToU8a } from '@polkadot/util';
+

Functions

bnToU8a

▸ bnToU8a(value: BN | number | null, options?: Options): Uint8Array

▸ bnToU8a(value: BN | number | null, bitLength?: undefined | number, isLe?: undefined | false | true): Uint8Array

Defined in bn/toU8a.ts:29

name: bnToU8a

summary: Creates a Uint8Array object from a BN.

description: null/undefined/NaN inputs returns an empty Uint8Array result. BN input values return the actual bytes value converted to a Uint8Array. Optionally convert using little-endian format if isLE is set.

example:

import { bnToU8a } from '@polkadot/util';
 
 bnToU8a(new BN(0x1234)); // => [0x12, 0x34]
-
1
2
3

Parameters:

Name Type
value BN | number | null
Optional options Options

Returns: Uint8Array

Defined in bn/toU8a.ts:30

Parameters:

Name Type
value BN | number | null
Optional bitLength undefined | number
Optional isLe undefined | false | true

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value BN | number | null
Optional options Options

Returns: Uint8Array

Defined in bn/toU8a.ts:30

Parameters:

Name Type
value BN | number | null
Optional bitLength undefined | number
Optional isLe undefined | false | true

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html b/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html index 847fc83b0..e542f0737 100644 --- a/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

bufferToU8a

▸ bufferToU8a(buffer?: Buffer | number[] | null): Uint8Array

Defined in buffer/toU8a.ts:19

name: bufferToU8a

summary: Creates a Uint8Array value from a Buffer object.

description: null inputs returns an empty result, Buffer values return the actual value as a Uint8Array. Anything that is not a Buffer object throws an error.

example:

import { bufferToU8a } from '@polkadot/util';
+

Functions

bufferToU8a

▸ bufferToU8a(buffer?: Buffer | number[] | null): Uint8Array

Defined in buffer/toU8a.ts:19

name: bufferToU8a

summary: Creates a Uint8Array value from a Buffer object.

description: null inputs returns an empty result, Buffer values return the actual value as a Uint8Array. Anything that is not a Buffer object throws an error.

example:

import { bufferToU8a } from '@polkadot/util';
 
 bufferToU8a(Buffer.from([1, 2, 3]));
-
1
2
3

Parameters:

Name Type
Optional buffer Buffer | number[] | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional buffer Buffer | number[] | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_addlength_.html b/docs/.vuepress/dist/util/modules/_compact_addlength_.html index 805295f25..e5eb2c80d 100644 --- a/docs/.vuepress/dist/util/modules/_compact_addlength_.html +++ b/docs/.vuepress/dist/util/modules/_compact_addlength_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactAddLength

▸ compactAddLength(input: Uint8Array): Uint8Array

Defined in compact/addLength.ts:20

name: compactAddLength

description: Adds a length prefix to the input value

example:

import { compactAddLength } from '@polkadot/util';
+

Functions

compactAddLength

▸ compactAddLength(input: Uint8Array): Uint8Array

Defined in compact/addLength.ts:20

name: compactAddLength

description: Adds a length prefix to the input value

example:

import { compactAddLength } from '@polkadot/util';
 
 console.log(compactAddLength(new Uint8Array([0xde, 0xad, 0xbe, 0xef]))); // Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef])
-
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_defaults_.html b/docs/.vuepress/dist/util/modules/_compact_defaults_.html index 3600b1ad1..b1a13e13d 100644 --- a/docs/.vuepress/dist/util/modules/_compact_defaults_.html +++ b/docs/.vuepress/dist/util/modules/_compact_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Variables

<Const> DEFAULT_BITLENGTH

● DEFAULT_BITLENGTH: BitLength = 32

Defined in compact/defaults.ts:7

Last Updated: 2/26/2019, 11:08:42 AM
- +

Variables

<Const> DEFAULT_BITLENGTH

● DEFAULT_BITLENGTH: BitLength = 32

Defined in compact/defaults.ts:7

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html b/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html index 035aac662..fbdee961c 100644 --- a/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html +++ b/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

compactFromU8a

▸ compactFromU8a(_input: Uint8Array | string, bitLength?: BitLength): [number, BN]

Defined in compact/fromU8a.ts:26

name: compactFromU8a

description: Retrievs the offset and encoded length from a compact-prefixed value

example:

import { compactFromU8a } from '@polkadot/util';
+

Functions

compactFromU8a

▸ compactFromU8a(_input: Uint8Array | string, bitLength?: BitLength): [number, BN]

Defined in compact/fromU8a.ts:26

name: compactFromU8a

description: Retrievs the offset and encoded length from a compact-prefixed value

example:

import { compactFromU8a } from '@polkadot/util';
 
 const [offset, length] = compactFromU8a(new Uint8Array([254, 255, 3, 0]), 32));
 
 console.log('value offset=', offset, 'length=', length); // 4, 0xffff
-
1
2
3
4
5

Parameters:

Name Type Default value
_input Uint8Array | string -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, BN]

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
_input Uint8Array | string -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, BN]

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_striplength_.html b/docs/.vuepress/dist/util/modules/_compact_striplength_.html index 67bd4f45e..e3fc8ca70 100644 --- a/docs/.vuepress/dist/util/modules/_compact_striplength_.html +++ b/docs/.vuepress/dist/util/modules/_compact_striplength_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactStripLength

▸ compactStripLength(input: Uint8Array, bitLength?: BitLength): [number, Uint8Array]

Defined in compact/stripLength.ts:22

name: compactStripLength

description: Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length

example:

import { compactStripLength } from '@polkadot/util';
+

Functions

compactStripLength

▸ compactStripLength(input: Uint8Array, bitLength?: BitLength): [number, Uint8Array]

Defined in compact/stripLength.ts:22

name: compactStripLength

description: Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length

example:

import { compactStripLength } from '@polkadot/util';
 
 console.log(compactStripLength(new Uint8Array([2 << 2, 0xde, 0xad]))); // [2, Uint8Array[0xde, 0xad]]
-
1
2
3

Parameters:

Name Type Default value
input Uint8Array -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, Uint8Array]

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
input Uint8Array -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, Uint8Array]

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_tou8a_.html b/docs/.vuepress/dist/util/modules/_compact_tou8a_.html index 7cb25cc81..4f9031583 100644 --- a/docs/.vuepress/dist/util/modules/_compact_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_compact_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactToU8a

▸ compactToU8a(_value: BN | number): Uint8Array

Defined in compact/toU8a.ts:27

name: compactToU8a

description: Encodes a number into a compact representation

example:

import { compactToU8a } from '@polkadot/util';
+

Functions

compactToU8a

▸ compactToU8a(_value: BN | number): Uint8Array

Defined in compact/toU8a.ts:27

name: compactToU8a

description: Encodes a number into a compact representation

example:

import { compactToU8a } from '@polkadot/util';
 
 console.log(compactToU8a(511, 32)); // Uint8Array([0b11111101, 0b00000111])
-
1
2
3

Parameters:

Name Type
_value BN | number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
_value BN | number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_compact_types_.html b/docs/.vuepress/dist/util/modules/_compact_types_.html index 274a3c868..e3f46ba6c 100644 --- a/docs/.vuepress/dist/util/modules/_compact_types_.html +++ b/docs/.vuepress/dist/util/modules/_compact_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

BitLength

Ƭ BitLength: 8 | 16 | 32 | 64 | 128 | 256

Defined in compact/types.ts:5

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

BitLength

Ƭ BitLength: 8 | 16 | 32 | 64 | 128 | 256

Defined in compact/types.ts:5

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_ext_error_.html b/docs/.vuepress/dist/util/modules/_ext_error_.html index 322756a87..48d956f29 100644 --- a/docs/.vuepress/dist/util/modules/_ext_error_.html +++ b/docs/.vuepress/dist/util/modules/_ext_error_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_addprefix_.html b/docs/.vuepress/dist/util/modules/_hex_addprefix_.html index 5d7ee07d8..056657cb1 100644 --- a/docs/.vuepress/dist/util/modules/_hex_addprefix_.html +++ b/docs/.vuepress/dist/util/modules/_hex_addprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexAddPrefix

▸ hexAddPrefix(value?: string | null): string

Defined in hex/addPrefix.ts:21

name: hexAddPrefix

summary: Adds the 0x prefix to string values.

description: Returns a 0x prefixed string from the input value. If the input is already prefixed, it is returned unchanged.

example:

import { hexAddPrefix } from '@polkadot/util';
+

Functions

hexAddPrefix

▸ hexAddPrefix(value?: string | null): string

Defined in hex/addPrefix.ts:21

name: hexAddPrefix

summary: Adds the 0x prefix to string values.

description: Returns a 0x prefixed string from the input value. If the input is already prefixed, it is returned unchanged.

example:

import { hexAddPrefix } from '@polkadot/util';
 
 console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_fixlength_.html b/docs/.vuepress/dist/util/modules/_hex_fixlength_.html index cd1604251..9043e6985 100644 --- a/docs/.vuepress/dist/util/modules/_hex_fixlength_.html +++ b/docs/.vuepress/dist/util/modules/_hex_fixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

hexFixLength

▸ hexFixLength(value: string, bitLength?: number, withPadding?: boolean): string

Defined in hex/fixLength.ts:24

name: hexFixLength

summary: Shifts a hex string to a specific bitLength

description: Returns a 0x prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When withPadding is set, shorter values are padded with 0.

example:

import { hexFixLength } from '@polkadot/util';
+

Functions

hexFixLength

▸ hexFixLength(value: string, bitLength?: number, withPadding?: boolean): string

Defined in hex/fixLength.ts:24

name: hexFixLength

summary: Shifts a hex string to a specific bitLength

description: Returns a 0x prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When withPadding is set, shorter values are padded with 0.

example:

import { hexFixLength } from '@polkadot/util';
 
 console.log('fixed', hexFixLength('0x12', 16)); // => 0x12
 console.log('fixed', hexFixLength('0x12', 16, true)); // => 0x0012
 console.log('fixed', hexFixLength('0x0012', 8)); // => 0x12
-
1
2
3
4
5

Parameters:

Name Type Default value
value string -
Default value bitLength number -1
Default value withPadding boolean false

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
value string -
Default value bitLength number -1
Default value withPadding boolean false

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html b/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html index 9877874cc..0cf6b7bf5 100644 --- a/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html +++ b/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexHasPrefix

▸ hexHasPrefix(value?: string | null): boolean

Defined in hex/hasPrefix.ts:21

name: hexHasPrefix

summary: Tests for the existence of a 0x prefix.

description: Checks for a valid hex input value and if the start matched 0x

example:

import { hexHasPrefix } from '@polkadot/util';
+

Functions

hexHasPrefix

▸ hexHasPrefix(value?: string | null): boolean

Defined in hex/hasPrefix.ts:21

name: hexHasPrefix

summary: Tests for the existence of a 0x prefix.

description: Checks for a valid hex input value and if the start matched 0x

example:

import { hexHasPrefix } from '@polkadot/util';
 
 console.log('has prefix', hexHasPrefix('0x1234')); // => true
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html b/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html index 7e2797df9..ad6d767a0 100644 --- a/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html +++ b/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexStripPrefix

▸ hexStripPrefix(value?: string | null): string

Defined in hex/stripPrefix.ts:23

name: hexStripPrefix

summary: Strips any leading 0x prefix.

description: Tests for the existence of a 0x prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.

example:

import { hexStripPrefix } from '@polkadot/util';
+

Functions

hexStripPrefix

▸ hexStripPrefix(value?: string | null): string

Defined in hex/stripPrefix.ts:23

name: hexStripPrefix

summary: Strips any leading 0x prefix.

description: Tests for the existence of a 0x prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.

example:

import { hexStripPrefix } from '@polkadot/util';
 
 console.log('stripped', hexStripPrefix('0x1234')); // => 1234
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_tobn_.html b/docs/.vuepress/dist/util/modules/_hex_tobn_.html index 1c2dae876..82853f6be 100644 --- a/docs/.vuepress/dist/util/modules/_hex_tobn_.html +++ b/docs/.vuepress/dist/util/modules/_hex_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexToBn

▸ hexToBn(value?: string | number | null, options?: ToBnOptions | boolean): BN

Defined in hex/toBn.ts:35

name: hexToBn

summary: Creates a BN.js bignumber object from a hex string.

description: null inputs returns a BN(0) result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToBn } from '@polkadot/util';
+

Functions

hexToBn

▸ hexToBn(value?: string | number | null, options?: ToBnOptions | boolean): BN

Defined in hex/toBn.ts:35

name: hexToBn

summary: Creates a BN.js bignumber object from a hex string.

description: null inputs returns a BN(0) result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToBn } from '@polkadot/util';
 
 hexToBn('0x123480001f'); // => BN(0x123480001f)
-
1
2
3

Parameters:

Name Type Default value
Optional value string | number | null -
Default value options ToBnOptions | boolean { isLe: false, isNegative: false }

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value string | number | null -
Default value options ToBnOptions | boolean { isLe: false, isNegative: false }

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_tonumber_.html b/docs/.vuepress/dist/util/modules/_hex_tonumber_.html index 67ca35c83..a20a5f90b 100644 --- a/docs/.vuepress/dist/util/modules/_hex_tonumber_.html +++ b/docs/.vuepress/dist/util/modules/_hex_tonumber_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexToNumber

▸ hexToNumber(value?: string | null): number

Defined in hex/toNumber.ts:21

name: hexToNumber

summary: Creates a Number value from a Buffer object.

description: null inputs returns an NaN result, hex values return the actual value as a Number.

example:

import { hexToNumber } from '@polkadot/util';
+

Functions

hexToNumber

▸ hexToNumber(value?: string | null): number

Defined in hex/toNumber.ts:21

name: hexToNumber

summary: Creates a Number value from a Buffer object.

description: null inputs returns an NaN result, hex values return the actual value as a Number.

example:

import { hexToNumber } from '@polkadot/util';
 
 hexToNumber('0x1234'); // => 0x1234
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_hex_tou8a_.html b/docs/.vuepress/dist/util/modules/_hex_tou8a_.html index 38017b40a..9a79d75e9 100644 --- a/docs/.vuepress/dist/util/modules/_hex_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_hex_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

hexToU8a

▸ hexToU8a(_value?: string | null, bitLength?: number): Uint8Array

Defined in hex/toU8a.ts:24

name: hexToU8a

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Uint8Array result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToU8a } from '@polkadot/util';
+

Functions

hexToU8a

▸ hexToU8a(_value?: string | null, bitLength?: number): Uint8Array

Defined in hex/toU8a.ts:24

name: hexToU8a

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Uint8Array result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToU8a } from '@polkadot/util';
 
 hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
 hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
-
1
2
3
4

Parameters:

Name Type Default value
Optional _value string | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional _value string | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_bn_.html b/docs/.vuepress/dist/util/modules/_is_bn_.html index 2f03a8bd6..0d3700c5f 100644 --- a/docs/.vuepress/dist/util/modules/_is_bn_.html +++ b/docs/.vuepress/dist/util/modules/_is_bn_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isBn

▸ isBn(value: any): boolean

Defined in is/bn.ts:22

name: isBn

summary: Tests for a BN object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import BN from 'bn.js';
+

Functions

isBn

▸ isBn(value: any): boolean

Defined in is/bn.ts:22

name: isBn

summary: Tests for a BN object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import BN from 'bn.js';
 import { isBn } from '@polkadot/util';
 
 console.log('isBn', isBn(new BN(1))); // => true
-
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_boolean_.html b/docs/.vuepress/dist/util/modules/_is_boolean_.html index 88a2d02c3..ff8277904 100644 --- a/docs/.vuepress/dist/util/modules/_is_boolean_.html +++ b/docs/.vuepress/dist/util/modules/_is_boolean_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isBoolean

▸ isBoolean(value: any): boolean

Defined in is/boolean.ts:19

name: isBoolean

summary: Tests for a boolean value.

description: Checks to see if the input value is a JavaScript boolean.

example:

import { isBoolean } from '@polkadot/util';
+

Functions

isBoolean

▸ isBoolean(value: any): boolean

Defined in is/boolean.ts:19

name: isBoolean

summary: Tests for a boolean value.

description: Checks to see if the input value is a JavaScript boolean.

example:

import { isBoolean } from '@polkadot/util';
 
 isBoolean(false); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_buffer_.html b/docs/.vuepress/dist/util/modules/_is_buffer_.html index 54f9a3d04..cd1785588 100644 --- a/docs/.vuepress/dist/util/modules/_is_buffer_.html +++ b/docs/.vuepress/dist/util/modules/_is_buffer_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isBuffer

▸ isBuffer(value: any): boolean

Defined in is/buffer.ts:21

name: isBuffer

summary: Tests for a Buffer object instance.

description: Checks to see if the input object is an instance of Buffer.

example:

import { isBuffer } from '@polkadot/util';
+

Functions

isBuffer

▸ isBuffer(value: any): boolean

Defined in is/buffer.ts:21

name: isBuffer

summary: Tests for a Buffer object instance.

description: Checks to see if the input object is an instance of Buffer.

example:

import { isBuffer } from '@polkadot/util';
 
 console.log('isBuffer', isBuffer(Buffer.from([]))); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_error_.html b/docs/.vuepress/dist/util/modules/_is_error_.html index 73489e3fa..72f8581db 100644 --- a/docs/.vuepress/dist/util/modules/_is_error_.html +++ b/docs/.vuepress/dist/util/modules/_is_error_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isError

▸ isError(value: any): boolean

Defined in is/error.ts:21

name: isError

summary: Tests for a Error object instance.

description: Checks to see if the input object is an instance of Error.

example:

import { isError } from '@polkadot/util';
+

Functions

isError

▸ isError(value: any): boolean

Defined in is/error.ts:21

name: isError

summary: Tests for a Error object instance.

description: Checks to see if the input object is an instance of Error.

example:

import { isError } from '@polkadot/util';
 
 console.log('isError', isError(new Error('message'))); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_function_.html b/docs/.vuepress/dist/util/modules/_is_function_.html index c59399bb6..86c58502a 100644 --- a/docs/.vuepress/dist/util/modules/_is_function_.html +++ b/docs/.vuepress/dist/util/modules/_is_function_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isFunction

▸ isFunction(value: any): boolean

Defined in is/function.ts:19

name: isFunction

summary: Tests for a function.

description: Checks to see if the input value is a JavaScript function.

example:

import { isFunction } from '@polkadot/util';
+

Functions

isFunction

▸ isFunction(value: any): boolean

Defined in is/function.ts:19

name: isFunction

summary: Tests for a function.

description: Checks to see if the input value is a JavaScript function.

example:

import { isFunction } from '@polkadot/util';
 
 isFunction(() => false); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_hex_.html b/docs/.vuepress/dist/util/modules/_is_hex_.html index d62c6d330..26cc76f89 100644 --- a/docs/.vuepress/dist/util/modules/_is_hex_.html +++ b/docs/.vuepress/dist/util/modules/_is_hex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isHex

▸ isHex(value: any, bitLength?: number, ignoreLength?: boolean): boolean

Defined in is/hex.ts:24

name: isHex

summary: Tests for a hex string.

description: Checks to see if the input value is a 0x prefixed hex string. Optionally (bitLength !== -1) checks to see if the bitLength is correct.

example:

import { isHex } from '@polkadot/util';
+

Functions

isHex

▸ isHex(value: any, bitLength?: number, ignoreLength?: boolean): boolean

Defined in is/hex.ts:24

name: isHex

summary: Tests for a hex string.

description: Checks to see if the input value is a 0x prefixed hex string. Optionally (bitLength !== -1) checks to see if the bitLength is correct.

example:

import { isHex } from '@polkadot/util';
 
 isHex('0x1234'); // => true
 isHex('0x1234', 8); // => false
-
1
2
3
4

Parameters:

Name Type Default value
value any -
Default value bitLength number -1
Default value ignoreLength boolean false

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
value any -
Default value bitLength number -1
Default value ignoreLength boolean false

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_instanceof_.html b/docs/.vuepress/dist/util/modules/_is_instanceof_.html index f13031cba..0d997c09d 100644 --- a/docs/.vuepress/dist/util/modules/_is_instanceof_.html +++ b/docs/.vuepress/dist/util/modules/_is_instanceof_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isInstanceOf

▸ isInstanceOf(value: any, clazz: any): boolean

Defined in is/instanceOf.ts:19

name: isInstanceOf

summary: Tests for a instance of a class.

description: Checks to see if the input value is an instance of the test class.

example:

import { isInstanceOf } from '@polkadot/util';
+

Functions

isInstanceOf

▸ isInstanceOf(value: any, clazz: any): boolean

Defined in is/instanceOf.ts:19

name: isInstanceOf

summary: Tests for a instance of a class.

description: Checks to see if the input value is an instance of the test class.

example:

import { isInstanceOf } from '@polkadot/util';
 
 console.log('isInstanceOf', isInstanceOf(new Array(0), Array)); // => true
-
1
2
3

Parameters:

Name Type
value any
clazz any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any
clazz any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_ip_.html b/docs/.vuepress/dist/util/modules/_is_ip_.html index 8ef6342e6..4116bf7af 100644 --- a/docs/.vuepress/dist/util/modules/_is_ip_.html +++ b/docs/.vuepress/dist/util/modules/_is_ip_.html @@ -7,7 +7,7 @@ - + @@ -15,13 +15,13 @@ GitHub

Functions

isIp

▸ isIp(value: string, type?: IpTypes): boolean

Defined in is/ip.ts:26

name: isIp

summary: Tests if the value is a valid IP address

description: Checks to see if the value is a valid IP address. Optionally check for either v4/v6

example:

import { isIp } from '@polkadot/util';
+

Functions

isIp

▸ isIp(value: string, type?: IpTypes): boolean

Defined in is/ip.ts:26

name: isIp

summary: Tests if the value is a valid IP address

description: Checks to see if the value is a valid IP address. Optionally check for either v4/v6

example:

import { isIp } from '@polkadot/util';
 
 isIp('192.168.0.1')); // => true
 isIp('1:2:3:4:5:6:7:8'); // => true
 isIp('192.168.0.1', 'v6')); // => false
 isIp('1:2:3:4:5:6:7:8', 'v4'); // => false
-
1
2
3
4
5
6

Parameters:

Name Type
value string
Optional type IpTypes

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
value string
Optional type IpTypes

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_null_.html b/docs/.vuepress/dist/util/modules/_is_null_.html index 579dd5fa6..dc658f22d 100644 --- a/docs/.vuepress/dist/util/modules/_is_null_.html +++ b/docs/.vuepress/dist/util/modules/_is_null_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isNull

▸ isNull(value?: any): boolean

Defined in is/null.ts:19

name: isNull

summary: Tests for a null values.

description: Checks to see if the input value is null.

example:

import { isNull } from '@polkadot/util';
+

Functions

isNull

▸ isNull(value?: any): boolean

Defined in is/null.ts:19

name: isNull

summary: Tests for a null values.

description: Checks to see if the input value is null.

example:

import { isNull } from '@polkadot/util';
 
 console.log('isNull', isNull(null)); // => true
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_number_.html b/docs/.vuepress/dist/util/modules/_is_number_.html index d416b621c..086f7e11f 100644 --- a/docs/.vuepress/dist/util/modules/_is_number_.html +++ b/docs/.vuepress/dist/util/modules/_is_number_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isNumber

▸ isNumber(value: any): boolean

Defined in is/number.ts:19

name: isNumber

summary: Tests for a JavaScript number.

description: Checks to see if the input value is a valid number.

example:

import { isNumber } from '@polkadot/util';
+

Functions

isNumber

▸ isNumber(value: any): boolean

Defined in is/number.ts:19

name: isNumber

summary: Tests for a JavaScript number.

description: Checks to see if the input value is a valid number.

example:

import { isNumber } from '@polkadot/util';
 
 console.log('isNumber', isNumber(1234)); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_object_.html b/docs/.vuepress/dist/util/modules/_is_object_.html index a525f8123..22292b6d6 100644 --- a/docs/.vuepress/dist/util/modules/_is_object_.html +++ b/docs/.vuepress/dist/util/modules/_is_object_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isObject

▸ isObject(value: any): boolean

Defined in is/object.ts:24

name: isObject

summary: Tests for an object.

description: Checks to see if the input value is a JavaScript object.

example:

import { isObject } from '@polkadot/util';
+

Functions

isObject

▸ isObject(value: any): boolean

Defined in is/object.ts:24

name: isObject

summary: Tests for an object.

description: Checks to see if the input value is a JavaScript object.

example:

import { isObject } from '@polkadot/util';
 
 isObject({}); // => true
 isObject('something'); // => false
-
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_observable_.html b/docs/.vuepress/dist/util/modules/_is_observable_.html index 2a09e1ebc..17dfc756e 100644 --- a/docs/.vuepress/dist/util/modules/_is_observable_.html +++ b/docs/.vuepress/dist/util/modules/_is_observable_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isObservable

▸ isObservable(value: any): boolean

Defined in is/observable.ts:26

name: isBObservable

summary: Tests for a Observable object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import { isObservable } from '@polkadot/util';
+

Functions

isObservable

▸ isObservable(value: any): boolean

Defined in is/observable.ts:26

name: isBObservable

summary: Tests for a Observable object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import { isObservable } from '@polkadot/util';
 
 console.log('isObservable', isObservable(...));
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_string_.html b/docs/.vuepress/dist/util/modules/_is_string_.html index 8cb4e1799..8a90cf17d 100644 --- a/docs/.vuepress/dist/util/modules/_is_string_.html +++ b/docs/.vuepress/dist/util/modules/_is_string_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isString

▸ isString(value: any): boolean

Defined in is/string.ts:19

name: isString

summary: Tests for a string.

description: Checks to see if the input value is a JavaScript string.

example:

import { isString } from '@polkadot/util';
+

Functions

isString

▸ isString(value: any): boolean

Defined in is/string.ts:19

name: isString

summary: Tests for a string.

description: Checks to see if the input value is a JavaScript string.

example:

import { isString } from '@polkadot/util';
 
 console.log('isString', isString('test')); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_u8a_.html b/docs/.vuepress/dist/util/modules/_is_u8a_.html index 8c513afdd..141d7de16 100644 --- a/docs/.vuepress/dist/util/modules/_is_u8a_.html +++ b/docs/.vuepress/dist/util/modules/_is_u8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isU8a

▸ isU8a(value?: any): boolean

Defined in is/u8a.ts:21

name: isU8a

summary: Tests for a Uint8Array object instance.

description: Checks to see if the input object is an instance of Uint8Array.

example:

import { isUint8Array } from '@polkadot/util';
+

Functions

isU8a

▸ isU8a(value?: any): boolean

Defined in is/u8a.ts:21

name: isU8a

summary: Tests for a Uint8Array object instance.

description: Checks to see if the input object is an instance of Uint8Array.

example:

import { isUint8Array } from '@polkadot/util';
 
 console.log('isU8a', isU8a([])); // => false
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_is_undefined_.html b/docs/.vuepress/dist/util/modules/_is_undefined_.html index 1555393a5..7358fd508 100644 --- a/docs/.vuepress/dist/util/modules/_is_undefined_.html +++ b/docs/.vuepress/dist/util/modules/_is_undefined_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isUndefined

▸ isUndefined(value?: any): boolean

Defined in is/undefined.ts:19

name: isUndefined

summary: Tests for a undefined values.

description: Checks to see if the input value is undefined.

example:

import { isUndefined } from '@polkadot/util';
+

Functions

isUndefined

▸ isUndefined(value?: any): boolean

Defined in is/undefined.ts:19

name: isUndefined

summary: Tests for a undefined values.

description: Checks to see if the input value is undefined.

example:

import { isUndefined } from '@polkadot/util';
 
 console.log('isUndefined', isUndefined(void(0))); // => true
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_logger_.html b/docs/.vuepress/dist/util/modules/_logger_.html index ead98e7b4..496140c1f 100644 --- a/docs/.vuepress/dist/util/modules/_logger_.html +++ b/docs/.vuepress/dist/util/modules/_logger_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

format

▸ format(value: any): any

Defined in logger.ts:42

Parameters:

Name Type
value any

Returns: any

logger

▸ logger(_type: string): Logger

Defined in logger.ts:104

name: Logger

summary: Creates a consistent log interface for messages

description: Returns a Logger that has .log, .error, .warn and .debug (controlled with environment DEBUG=typeA,typeB) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.

example:

const l from '@polkadot/util/logger')('test');
+

Functions

format

▸ format(value: any): any

Defined in logger.ts:42

Parameters:

Name Type
value any

Returns: any

logger

▸ logger(_type: string): Logger

Defined in logger.ts:104

name: Logger

summary: Creates a consistent log interface for messages

description: Returns a Logger that has .log, .error, .warn and .debug (controlled with environment DEBUG=typeA,typeB) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.

example:

const l from '@polkadot/util/logger')('test');
 
 l.log('blah'); // <date>     TEST: blah
-
1
2
3

Parameters:

Name Type
_type string

Returns: Logger

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
_type string

Returns: Logger

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_number_tohex_.html b/docs/.vuepress/dist/util/modules/_number_tohex_.html index 05d3c31f3..6e29b0a68 100644 --- a/docs/.vuepress/dist/util/modules/_number_tohex_.html +++ b/docs/.vuepress/dist/util/modules/_number_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

numberToHex

▸ numberToHex(value?: number | null, bitLength?: number): string

Defined in number/toHex.ts:24

name: numberToHex

summary: Creates a hex value from a number.

description: null/undefined/NaN inputs returns an empty 0x result. number input values return the actual bytes value converted to a hex. With bitLength set, it converts the number to the equivalent size.

example:

import { numberToHex } from '@polkadot/util';
+

Functions

numberToHex

▸ numberToHex(value?: number | null, bitLength?: number): string

Defined in number/toHex.ts:24

name: numberToHex

summary: Creates a hex value from a number.

description: null/undefined/NaN inputs returns an empty 0x result. number input values return the actual bytes value converted to a hex. With bitLength set, it converts the number to the equivalent size.

example:

import { numberToHex } from '@polkadot/util';
 
 numberToHex(0x1234); // => '0x1234'
 numberToHex(0x1234, 32); // => 0x00001234
-
1
2
3
4

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_number_tou8a_.html b/docs/.vuepress/dist/util/modules/_number_tou8a_.html index c2319b3d9..3039a8774 100644 --- a/docs/.vuepress/dist/util/modules/_number_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_number_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

numberToU8a

▸ numberToU8a(value?: number | null, bitLength?: number): Uint8Array

Defined in number/toU8a.ts:22

name: numberToU8a

summary: Creates a Uint8Array object from a number.

description: null/undefined/NaN inputs returns an empty Uint8Array result. number input values return the actual bytes value converted to a Uint8Array. With bitLength, it converts the value to the equivalent size.

example:

import { numberToU8a } from '@polkadot/util';
+

Functions

numberToU8a

▸ numberToU8a(value?: number | null, bitLength?: number): Uint8Array

Defined in number/toU8a.ts:22

name: numberToU8a

summary: Creates a Uint8Array object from a number.

description: null/undefined/NaN inputs returns an empty Uint8Array result. number input values return the actual bytes value converted to a Uint8Array. With bitLength, it converts the value to the equivalent size.

example:

import { numberToU8a } from '@polkadot/util';
 
 numberToU8a(0x1234); // => [0x12, 0x34]
-
1
2
3

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_fill_.html b/docs/.vuepress/dist/util/modules/_polyfill_fill_.html index 15c048c7c..de9e21e5d 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_fill_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_fill_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_padend_.html b/docs/.vuepress/dist/util/modules/_polyfill_padend_.html index 830e81c69..f539854e6 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_padend_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_padend_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html b/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html index 755189813..2e5bd2f1f 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html b/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html index f054beb49..077b40553 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html b/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html index aff8e9dc1..f6bc5b1a6 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html b/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html index a71c09cf0..59beaa7b4 100644 --- a/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html +++ b/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_promisify_.html b/docs/.vuepress/dist/util/modules/_promisify_.html index 536f78dcc..a2ff90291 100644 --- a/docs/.vuepress/dist/util/modules/_promisify_.html +++ b/docs/.vuepress/dist/util/modules/_promisify_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

promisify

▸ promisify(self: any, fn: Function, ...params: Array<any>): Promise<any>

Defined in promisify.ts:20

name: promisify

summary: Wraps an async callback into a Promise

description: Wraps the supplied async function fn that has a standard JS callback (error: Error, result: any) into a Promise, passing the supplied parameters. When error is set, the Promise is rejected, else the Promise resolves with the result value.

example:

const { promisify } from '@polkadot/util';
+

Functions

promisify

▸ promisify(self: any, fn: Function, ...params: Array<any>): Promise<any>

Defined in promisify.ts:20

name: promisify

summary: Wraps an async callback into a Promise

description: Wraps the supplied async function fn that has a standard JS callback (error: Error, result: any) into a Promise, passing the supplied parameters. When error is set, the Promise is rejected, else the Promise resolves with the result value.

example:

const { promisify } from '@polkadot/util';
 
 await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
 await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
-
1
2
3
4

Parameters:

Name Type
self any
fn Function
Rest params Array<any>

Returns: Promise<any>

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
self any
fn Function
Rest params Array<any>

Returns: Promise<any>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_string_camelcase_.html b/docs/.vuepress/dist/util/modules/_string_camelcase_.html index 689b02b32..1cd1bf99a 100644 --- a/docs/.vuepress/dist/util/modules/_string_camelcase_.html +++ b/docs/.vuepress/dist/util/modules/_string_camelcase_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html b/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html index 6a3021441..3703daca2 100644 --- a/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html +++ b/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringLowerFirst

▸ stringLowerFirst(value?: string | null): string

Defined in string/lowerFirst.ts:19

name: stringLowerFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringLowerFirst } from '@polkadot/util';
+

Functions

stringLowerFirst

▸ stringLowerFirst(value?: string | null): string

Defined in string/lowerFirst.ts:19

name: stringLowerFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringLowerFirst } from '@polkadot/util';
 
 stringLowerFirst('ABC'); // => 'aBC'
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_string_shorten_.html b/docs/.vuepress/dist/util/modules/_string_shorten_.html index 7edf7b303..48152d317 100644 --- a/docs/.vuepress/dist/util/modules/_string_shorten_.html +++ b/docs/.vuepress/dist/util/modules/_string_shorten_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringShorten

▸ stringShorten(_value?: any, prefixLength?: number): string

Defined in string/shorten.ts:19

name: stringShorten

summary: Returns a string with maximum length

description: Checks the string against the prefixLength, if longer than dopuble this, shortens it by placing .. in the middle of it

example:

import { stringShorten } from '@polkadot/util';
+

Functions

stringShorten

▸ stringShorten(_value?: any, prefixLength?: number): string

Defined in string/shorten.ts:19

name: stringShorten

summary: Returns a string with maximum length

description: Checks the string against the prefixLength, if longer than dopuble this, shortens it by placing .. in the middle of it

example:

import { stringShorten } from '@polkadot/util';
 
 stringShorten('1234567890', 2); // => 12..90
-
1
2
3

Parameters:

Name Type Default value
Optional _value any -
Default value prefixLength number 6

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional _value any -
Default value prefixLength number 6

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_string_tou8a_.html b/docs/.vuepress/dist/util/modules/_string_tou8a_.html index ceb3867b6..5232134f0 100644 --- a/docs/.vuepress/dist/util/modules/_string_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_string_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringToU8a

▸ stringToU8a(value?: undefined | string): Uint8Array

Defined in string/toU8a.ts:39

name: stringToU8a

summary: Creates a Uint8Array object from a utf-8 string.

description: String input values return the actual encoded UInt8Array. null or undefined values returns an empty encoded array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

stringToU8a

▸ stringToU8a(value?: undefined | string): Uint8Array

Defined in string/toU8a.ts:39

name: stringToU8a

summary: Creates a Uint8Array object from a utf-8 string.

description: String input values return the actual encoded UInt8Array. null or undefined values returns an empty encoded array.

example:

import { stringToU8a } from '@polkadot/util';
 
 stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
-
1
2
3

Parameters:

Name Type
Optional value undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_string_upperfirst_.html b/docs/.vuepress/dist/util/modules/_string_upperfirst_.html index 2b2f0edd6..19e7d69aa 100644 --- a/docs/.vuepress/dist/util/modules/_string_upperfirst_.html +++ b/docs/.vuepress/dist/util/modules/_string_upperfirst_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringUpperFirst

▸ stringUpperFirst(value?: string | null): string

Defined in string/upperFirst.ts:19

name: stringUpperFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringUpperFirst } from '@polkadot/util';
+

Functions

stringUpperFirst

▸ stringUpperFirst(value?: string | null): string

Defined in string/upperFirst.ts:19

name: stringUpperFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringUpperFirst } from '@polkadot/util';
 
 stringUpperFirst('abc'); // => 'Abc'
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_syncify_.html b/docs/.vuepress/dist/util/modules/_syncify_.html index f600381d2..f9f52bca9 100644 --- a/docs/.vuepress/dist/util/modules/_syncify_.html +++ b/docs/.vuepress/dist/util/modules/_syncify_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

syncify

▸ syncify(promise: Promise<any>): any

Defined in syncify.ts:11

Parameters:

Name Type
promise Promise<any>

Returns: any

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

syncify

▸ syncify(promise: Promise<any>): any

Defined in syncify.ts:11

Parameters:

Name Type
promise Promise<any>

Returns: any

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_types_.html b/docs/.vuepress/dist/util/modules/_types_.html index 3c5ca7a2d..b252d2da4 100644 --- a/docs/.vuepress/dist/util/modules/_types_.html +++ b/docs/.vuepress/dist/util/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

Logger

Ƭ Logger: object

Defined in types.ts:15

Type declaration

Logger$Data

Ƭ Logger$Data: Array<any | Logger$Data$Fn>

Defined in types.ts:13

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

Logger

Ƭ Logger: object

Defined in types.ts:15

Type declaration

Logger$Data

Ƭ Logger$Data: Array<any | Logger$Data$Fn>

Defined in types.ts:13

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_concat_.html b/docs/.vuepress/dist/util/modules/_u8a_concat_.html index b6e29015b..402e0a961 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_concat_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_concat_.html @@ -7,7 +7,7 @@ - + @@ -15,13 +15,13 @@ GitHub

Functions

u8aConcat

▸ u8aConcat(..._list: Array<Uint8Array | string>): Uint8Array

Defined in u8a/concat.ts:24

name: u8aConcat

summary: Creates a concatenated Uint8Array from the inputs.

description: Concatenates the input arrays into a single UInt8Array.

example:

import { u8aConcat } from '@polkadot/util';
+

Functions

u8aConcat

▸ u8aConcat(..._list: Array<Uint8Array | string>): Uint8Array

Defined in u8a/concat.ts:24

name: u8aConcat

summary: Creates a concatenated Uint8Array from the inputs.

description: Concatenates the input arrays into a single UInt8Array.

example:

import { u8aConcat } from '@polkadot/util';
 
 u8aConcat(
   new Uint8Array([1, 2, 3]),
   new Uint8Array([4, 5, 6])
 ); // [1, 2, 3, 4, 5, 6]
-
1
2
3
4
5
6

Parameters:

Name Type
Rest _list Array<Uint8Array | string>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
Rest _list Array<Uint8Array | string>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html b/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html index 43631e37b..e509030b1 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

u8aFixLength

▸ u8aFixLength(value: Uint8Array, bitLength?: number, atStart?: boolean): Uint8Array

Defined in u8a/fixLength.ts:21

name: u8aFixLength

summary: Shifts a Uint8Array to a specific bitLength

description: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.

example:

import { u8aFixLength } from '@polkadot/util';
+

Functions

u8aFixLength

▸ u8aFixLength(value: Uint8Array, bitLength?: number, atStart?: boolean): Uint8Array

Defined in u8a/fixLength.ts:21

name: u8aFixLength

summary: Shifts a Uint8Array to a specific bitLength

description: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.

example:

import { u8aFixLength } from '@polkadot/util';
 
 u8aFixLength('0x12') // => 0x12
 u8aFixLength('0x12', 16) // => 0x0012
 u8aFixLength('0x1234', 8) // => 0x12
-
1
2
3
4
5

Parameters:

Name Type Default value
value Uint8Array -
Default value bitLength number -1
Default value atStart boolean false

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
value Uint8Array -
Default value bitLength number -1
Default value atStart boolean false

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_tobn_.html b/docs/.vuepress/dist/util/modules/_u8a_tobn_.html index c1363b674..2ee815f8b 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_tobn_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToBn

▸ u8aToBn(value: Uint8Array, options?: ToBnOptions | boolean): BN

Defined in u8a/toBn.ts:29

name: u8aToBn

summary: Creates a BN from a Uint8Array object.

description: UInt8Array input values return the actual BN. null or undefined values returns an 0x0 value.

example:

import { u8aToBn } from '@polkadot/util';
+

Functions

u8aToBn

▸ u8aToBn(value: Uint8Array, options?: ToBnOptions | boolean): BN

Defined in u8a/toBn.ts:29

name: u8aToBn

summary: Creates a BN from a Uint8Array object.

description: UInt8Array input values return the actual BN. null or undefined values returns an 0x0 value.

example:

import { u8aToBn } from '@polkadot/util';
 
 u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
-
1
2
3

Parameters:

Name Type Default value Description
value Uint8Array - The value to convert
Default value options ToBnOptions | boolean { isLe: true, isNegative: false } Options to pass while converting

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value Description
value Uint8Array - The value to convert
Default value options ToBnOptions | boolean { isLe: true, isNegative: false } Options to pass while converting

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html b/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html index f5c611760..e7289b76b 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToBuffer

▸ u8aToBuffer(value?: Uint8Array | null): Buffer

Defined in u8a/toBuffer.ts:19

name: u8aToBuffer

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Buffer result. UInt8Array input values return the actual bytes value converted to a Buffer. Anything that is not a UInt8Array throws an error.

example:

import { u8aToBuffer } from '@polkadot/util';
+

Functions

u8aToBuffer

▸ u8aToBuffer(value?: Uint8Array | null): Buffer

Defined in u8a/toBuffer.ts:19

name: u8aToBuffer

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Buffer result. UInt8Array input values return the actual bytes value converted to a Buffer. Anything that is not a UInt8Array throws an error.

example:

import { u8aToBuffer } from '@polkadot/util';
 
 console.log('Buffer', u8aToBuffer('0x123480001f'));
-
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: Buffer

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: Buffer

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_tohex_.html b/docs/.vuepress/dist/util/modules/_u8a_tohex_.html index e3ba63efc..a93890bb1 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_tohex_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToHex

▸ u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): string

Defined in u8a/toHex.ts:21

name: u8aToHex

summary: Creates a hex string from a Uint8Array object.

description: UInt8Array input values return the actual hex string. null or undefined values returns an 0x string.

example:

import { u8aToHex } from '@polkadot/util';
+

Functions

u8aToHex

▸ u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): string

Defined in u8a/toHex.ts:21

name: u8aToHex

summary: Creates a hex string from a Uint8Array object.

description: UInt8Array input values return the actual hex string. null or undefined values returns an 0x string.

example:

import { u8aToHex } from '@polkadot/util';
 
 u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
-
1
2
3

Parameters:

Name Type Default value
Optional value Uint8Array | null -
Default value bitLength number -1
Default value isPrefixed boolean true

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value Uint8Array | null -
Default value bitLength number -1
Default value isPrefixed boolean true

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_tostring_.html b/docs/.vuepress/dist/util/modules/_u8a_tostring_.html index 8fdb9b8c5..b9a0b382a 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_tostring_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_tostring_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToString

▸ u8aToString(value?: Uint8Array | null): string

Defined in u8a/toString.ts:35

name: u8aToString

summary: Creates a utf-8 string from a Uint8Array object.

description: UInt8Array input values return the actual decoded utf-8 string. null or undefined values returns an empty string.

example:

import { u8aToString } from '@polkadot/util';
+

Functions

u8aToString

▸ u8aToString(value?: Uint8Array | null): string

Defined in u8a/toString.ts:35

name: u8aToString

summary: Creates a utf-8 string from a Uint8Array object.

description: UInt8Array input values return the actual decoded utf-8 string. null or undefined values returns an empty string.

example:

import { u8aToString } from '@polkadot/util';
 
 u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello
-
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html b/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html index bea26c573..a51869bb1 100644 --- a/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html +++ b/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

u8aToU8a

▸ u8aToU8a(value?: Array<number> | Buffer | Uint8Array | string | null): Uint8Array

Defined in u8a/toU8a.ts:27

name: u8aToU8a

summary: Creates a Uint8Array value from a Uint8Array bignumber or hex input.

description: null inputs returns a [] result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.

example:

import { u8aToU8a } from '@polkadot/util';
+

Functions

u8aToU8a

▸ u8aToU8a(value?: Array<number> | Buffer | Uint8Array | string | null): Uint8Array

Defined in u8a/toU8a.ts:27

name: u8aToU8a

summary: Creates a Uint8Array value from a Uint8Array bignumber or hex input.

description: null inputs returns a [] result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.

example:

import { u8aToU8a } from '@polkadot/util';
 
 u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
 u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
-
1
2
3
4

Parameters:

Name Type
Optional value Array<number> | Buffer | Uint8Array | string | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
Optional value Array<number> | Buffer | Uint8Array | string | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/404.html b/docs/404.html index c0aa2c72b..0bb95ee11 100644 --- a/docs/404.html +++ b/docs/404.html @@ -7,11 +7,11 @@ - +

404

There's nothing here.
Take me home.
- + diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index 1cc033f1c..b8226d2a4 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. +

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

. No --force pushes or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo. . Non-master branches, prefixed with a short name moniker (e.g. <initials>-<feature>) must be used for ongoing work. . All modifications must be made in a pull-request to solicit feedback from other contributors. @@ -28,11 +28,11 @@ When reviewing a pull request, the end-goal is to suggest useful changes to the . Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on). . Uselessness (i.e. it does not strictly add a feature or fix a known issue).

.Reviews may not be used as an effective veto for a PR because: . There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix. -. It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

Last Updated: 2/13/2019, 4:33:49 PM

+. It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

Last Updated: 2/13/2019, 4:38:56 PM

←

- + diff --git a/docs/assets/js/100.eada1ee7.js b/docs/assets/js/100.eada1ee7.js new file mode 100644 index 000000000..c2c0157b3 --- /dev/null +++ b/docs/assets/js/100.eada1ee7.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{483:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"sharedprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"sharedprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sharedprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" sharedPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sharedPrefixLength")]),t._v("(first: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", second: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/sharedPrefixLength.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/sharedPrefixLength.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("first")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("second")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/101.c0266c71.js b/docs/assets/js/101.c0266c71.js new file mode 100644 index 000000000..ab64f471b --- /dev/null +++ b/docs/assets/js/101.c0266c71.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{485:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tonibbles"}})]),t._v(" "),a("h2",{attrs:{id:"tonibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tonibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" toNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toNibbles")]),t._v("(input?: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/toNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/toNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": toNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" toNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x41")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([4, 1, 2, 0])")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("null")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/102.bbdf1551.js b/docs/assets/js/102.bbdf1551.js new file mode 100644 index 000000000..ab284fe06 --- /dev/null +++ b/docs/assets/js/102.bbdf1551.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{482:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-trie-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),a("p",[t._v("A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.")]),t._v(" "),a("p",[t._v("This is a JavaScript port of the "),a("a",{attrs:{href:"https://github.com/ethereum/py-trie",target:"_blank",rel:"noopener noreferrer"}},[t._v("Python Ethereum Trie"),a("OutboundLink")],1),t._v(" with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/trie-db\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Classes can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Trie "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-db'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Default export")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/trie-db/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/104.08626032.js b/docs/assets/js/104.08626032.js new file mode 100644 index 000000000..34b7c728d --- /dev/null +++ b/docs/assets/js/104.08626032.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{479:function(t,r,e){"use strict";e.r(r);var o=e(46),s=Object(o.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("Checkpoint")])]),t._v(" "),e("p",[t._v("↳ "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Checkpoint")]),t._v("(rootHash: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Checkpoint.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("Checkpoint.ts:7"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/105.3756f026.js b/docs/assets/js/105.3756f026.js new file mode 100644 index 000000000..8fb932bfa --- /dev/null +++ b/docs/assets/js/105.3756f026.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{477:function(t,r,e){"use strict";e.r(r);var a=e(46),o=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-trie-db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-db","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-db")]),t._v(" "),e("h2",{attrs:{id:"overview"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Re-implementation of a Patricia Trie")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(": See "),e("a",{attrs:{href:"https://polkadot.js.org/api/common/examples/trie-db/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkadot-JS Common Trie-DB Examples"),e("OutboundLink")],1)]),t._v(" "),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1),t._v(" "),e("p",[e("strong",[t._v("↳ Impl")])]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Impl")]),t._v("(db: "),e("em",[e("code",[t._v("TxDb")])]),t._v(", rootHash?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", codec?: "),e("em",[e("code",[t._v("Codec")])]),t._v("): "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("p",[e("em",[t._v("Overrides "),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")]),t._v("."),e("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:38"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("db")]),t._v(" "),e("td",[e("code",[t._v("TxDb")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" rootHash")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),e("td",[e("code",[t._v("Codec")])]),t._v(" "),e("td",[t._v("substrateCodec")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"db"}})]),t._v(" "),e("h2",{attrs:{id:"db"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),e("p",[e("strong",[t._v("● db")]),t._v(": "),e("em",[e("code",[t._v("TxDb")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("Impl.ts:36"),e("OutboundLink")],1)])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/106.9b5387d2.js b/docs/assets/js/106.9b5387d2.js new file mode 100644 index 000000000..dfeb9b547 --- /dev/null +++ b/docs/assets/js/106.9b5387d2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{476:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#extension"}},[t._v("EXTENSION")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 3")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extension"}})]),t._v(" "),r("h2",{attrs:{id:"extension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extension","aria-hidden":"true"}},[t._v("#")]),t._v(" EXTENSION")]),t._v(" "),r("p",[r("strong",[t._v("EXTENSION")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/107.ac0410cf.js b/docs/assets/js/107.ac0410cf.js new file mode 100644 index 000000000..664efa390 --- /dev/null +++ b/docs/assets/js/107.ac0410cf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{474:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("TxDb")])]),t._v(" "),r("p",[r("strong",[t._v("↳ TrieDb")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"db"}})]),t._v(" "),r("h2",{attrs:{id:"db"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#db","aria-hidden":"true"}},[t._v("#")]),t._v(" db")]),t._v(" "),r("p",[r("strong",[t._v("● db")]),t._v(": "),r("em",[r("code",[t._v("TxDb")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.close")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.del")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.drop")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.empty")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getroot"}})]),t._v(" "),r("h2",{attrs:{id:"getroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getroot","aria-hidden":"true"}},[t._v("#")]),t._v(" getRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getRoot")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.maintain")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.open")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.put")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.rename")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setroot"}})]),t._v(" "),r("h2",{attrs:{id:"setroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setroot","aria-hidden":"true"}},[t._v("#")]),t._v(" setRoot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setRoot")]),t._v("(rootHash: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("rootHash")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from BaseDb.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"snapshot"}})]),t._v(" "),r("h2",{attrs:{id:"snapshot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#snapshot","aria-hidden":"true"}},[t._v("#")]),t._v(" snapshot")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("snapshot")]),t._v("(dest: "),r("em",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1),t._v(", fn: "),r("em",[r("code",[t._v("ProgressCb")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("dest")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1)]),t._v(" "),r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("ProgressCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from TxDb.transaction")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/109.f796e243.js b/docs/assets/js/109.f796e243.js new file mode 100644 index 000000000..bb5b05912 --- /dev/null +++ b/docs/assets/js/109.f796e243.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{471:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"constants"}})]),t._v(" "),a("h2",{attrs:{id:"constants"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constants","aria-hidden":"true"}},[t._v("#")]),t._v(" Constants")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Constants")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"default"}})]),t._v(" "),a("h2",{attrs:{id:"default"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default","aria-hidden":"true"}},[t._v("#")]),t._v(" default")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("default")]),t._v("(codec: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("object")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("object")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/11.ea4175ac.js b/docs/assets/js/11.ea4175ac.js new file mode 100644 index 000000000..1c6570dee --- /dev/null +++ b/docs/assets/js/11.ea4175ac.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{391:function(e,t,a){"use strict";a.r(t);var s=a(46),r=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"chainspec"}})]),e._v(" "),a("h2",{attrs:{id:"chainspec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#chainspec","aria-hidden":"true"}},[e._v("#")]),e._v(" Chainspec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Chainspec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/chainspec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/111.b00ef71d.js b/docs/assets/js/111.b00ef71d.js new file mode 100644 index 000000000..73e08e579 --- /dev/null +++ b/docs/assets/js/111.b00ef71d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{468:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/112.3bdcdd17.js b/docs/assets/js/112.3bdcdd17.js new file mode 100644 index 000000000..d2abcfb46 --- /dev/null +++ b/docs/assets/js/112.3bdcdd17.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{467:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"enumerations"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1)]),e._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[e._v("TrieDb")])],1)]),e._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedpath"}})]),e._v(" "),r("h2",{attrs:{id:"encodedpath"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedpath","aria-hidden":"true"}},[e._v("#")]),e._v(" EncodedPath")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ EncodedPath")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"node"}})]),e._v(" "),r("h2",{attrs:{id:"node"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#node","aria-hidden":"true"}},[e._v("#")]),e._v(" Node")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Node")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodenotempty"}},[e._v("NodeNotEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodebranch"}})]),e._v(" "),r("h2",{attrs:{id:"nodebranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodebranch","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeBranch")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeBranch")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEmpty")]),e._v(": "),r("em",[r("code",[e._v("null")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencoded"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencoded"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencoded","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncoded")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncoded")]),e._v(": "),r("em",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodeencodedorempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodeencodedorempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodeencodedorempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeEncodedOrEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeEncodedOrEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencoded"}},[e._v("NodeEncoded")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeempty"}},[e._v("NodeEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodekv"}})]),e._v(" "),r("h2",{attrs:{id:"nodekv"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodekv","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeKv")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeKv")]),e._v(": "),r("em",[e._v("["),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[e._v("EncodedPath")]),e._v(", "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodeencodedorempty"}},[e._v("NodeEncodedOrEmpty")]),e._v("]")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodenotempty"}})]),e._v(" "),r("h2",{attrs:{id:"nodenotempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodenotempty","aria-hidden":"true"}},[e._v("#")]),e._v(" NodeNotEmpty")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ NodeNotEmpty")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodekv"}},[e._v("NodeKv")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#nodebranch"}},[e._v("NodeBranch")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/113.a1e71949.js b/docs/assets/js/113.a1e71949.js new file mode 100644 index 000000000..bdad21d06 --- /dev/null +++ b/docs/assets/js/113.a1e71949.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{465:function(e,t,r){"use strict";r.r(t);var o=r(46),n=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"isbranchnode"}})]),e._v(" "),r("h2",{attrs:{id:"isbranchnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isbranchnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isBranchNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isBranchNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isBranchNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Branch 17-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isemptynode"}})]),e._v(" "),r("h2",{attrs:{id:"isemptynode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isemptynode","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmptyNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isEmptyNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isEmptyNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is NULL")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isextensionnode"}})]),e._v(" "),r("h2",{attrs:{id:"isextensionnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isextensionnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isExtensionNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isExtensionNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isExtensionNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Extension 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"iskvnode"}})]),e._v(" "),r("h2",{attrs:{id:"iskvnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iskvnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isKvNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isKvNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isKvNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is not empty and contains a single key/value pair")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isleafnode"}})]),e._v(" "),r("h2",{attrs:{id:"isleafnode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isleafnode","aria-hidden":"true"}},[e._v("#")]),e._v(" isLeafNode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isLeafNode")]),e._v("(node: "),r("em",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/is.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": isLeafNode")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("summary")])]),e._v(": Returns true if node is an Leaf 2-item node")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Refer to "),r("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization",target:"_blank",rel:"noopener noreferrer"}},[e._v("Merkle Patricia Trie specification"),r("OutboundLink")],1)]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("node")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/114.e6b445cc.js b/docs/assets/js/114.e6b445cc.js new file mode 100644 index 000000000..126f528a0 --- /dev/null +++ b/docs/assets/js/114.e6b445cc.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{464:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"computeextensionkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeextensionkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeextensionkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeExtensionKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeExtensionKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"computeleafkey"}})]),t._v(" "),r("h2",{attrs:{id:"computeleafkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#computeleafkey","aria-hidden":"true"}},[t._v("#")]),t._v(" computeLeafKey")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("computeLeafKey")]),t._v("(nibbles: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("nibbles")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/trie-db/modules/_types_.html#encodedpath"}},[t._v("EncodedPath")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"consumecommonprefix"}})]),t._v(" "),r("h2",{attrs:{id:"consumecommonprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#consumecommonprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" consumeCommonPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("consumeCommonPrefix")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" ["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getcommonprefixlength"}})]),t._v(" "),r("h2",{attrs:{id:"getcommonprefixlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getcommonprefixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" getCommonPrefixLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getCommonPrefixLength")]),t._v("(left: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", right: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("left")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("right")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keyequals"}})]),t._v(" "),r("h2",{attrs:{id:"keyequals"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyequals","aria-hidden":"true"}},[t._v("#")]),t._v(" keyEquals")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyEquals")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", test: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("test")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keystartswith"}})]),t._v(" "),r("h2",{attrs:{id:"keystartswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keystartswith","aria-hidden":"true"}},[t._v("#")]),t._v(" keyStartsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keyStartsWith")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", partial: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/key.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("partial")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/115.62463929.js b/docs/assets/js/115.62463929.js new file mode 100644 index 000000000..cfe8fd4c6 --- /dev/null +++ b/docs/assets/js/115.62463929.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{462:function(e,t,o){"use strict";o.r(t);var r=o(46),d=Object(r.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),o("p",[o("a",{attrs:{id:"decodenode"}})]),e._v(" "),o("h2",{attrs:{id:"decodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("decodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", encoded: "),o("em",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:30"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("encoded")]),e._v(" "),o("td",[o("code",[e._v("Uint8Array")]),e._v(" | "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"encodenode"}})]),e._v(" "),o("h2",{attrs:{id:"encodenode"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#encodenode","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNode")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("encodeNode")]),e._v("(codec: "),o("em",[o("code",[e._v("Codec")])]),e._v(", node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:46"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("codec")]),e._v(" "),o("td",[o("code",[e._v("Codec")])])]),e._v(" "),o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Uint8Array")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getnodetype"}})]),e._v(" "),o("h2",{attrs:{id:"getnodetype"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#getnodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" getNodeType")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getNodeType")]),e._v("(node: "),o("em",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1),e._v("): "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/node.ts:13"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("node")]),e._v(" "),o("td",[o("router-link",{attrs:{to:"/trie-db/modules/_types_.html#node"}},[e._v("Node")])],1)])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[e._v("NodeType")])],1),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/118.cc136900.js b/docs/assets/js/118.cc136900.js new file mode 100644 index 000000000..112484c20 --- /dev/null +++ b/docs/assets/js/118.cc136900.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{458:function(t,e,r){"use strict";r.r(e);var v=r(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"buildtrie"}})]),t._v(" "),r("h2",{attrs:{id:"buildtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buildtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" buildTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("buildTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(", cursor?: "),r("em",[r("code",[t._v("number")])]),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v(", stream?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/buildTrie.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("buildTrie.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<["),r("code",[t._v("Uint8Array")]),t._v(", "),r("code",[t._v("Uint8Array")]),t._v("]>")]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" cursor")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("0")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" stream")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("DEFAULT_STREAM")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/119.294e232e.js b/docs/assets/js/119.294e232e.js new file mode 100644 index 000000000..a72c97da2 --- /dev/null +++ b/docs/assets/js/119.294e232e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{453:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/120.83f82f71.js b/docs/assets/js/120.83f82f71.js new file mode 100644 index 000000000..3fbf5dff2 --- /dev/null +++ b/docs/assets/js/120.83f82f71.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{455:function(t,a,s){"use strict";s.r(a);var r=s(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"trieroot"}})]),t._v(" "),s("h2",{attrs:{id:"trieroot"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#trieroot","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRoot")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("trieRoot")]),t._v("(input: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),s("em",[s("code",[t._v("Codec")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRoot.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRoot.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": trieRoot")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied pairs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From an "),s("code",[t._v("Array<{k: Uint8Array, v: Uint8Array}>")]),t._v(" input, calculate the triehash and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRoot "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRoot")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n k"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n v"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),s("td",[s("code",[t._v("Codec")])]),t._v(" "),s("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/121.b9ffa863.js b/docs/assets/js/121.b9ffa863.js new file mode 100644 index 000000000..d67df6653 --- /dev/null +++ b/docs/assets/js/121.b9ffa863.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{452:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"trierootordered"}})]),t._v(" "),a("h2",{attrs:{id:"trierootordered"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#trierootordered","aria-hidden":"true"}},[t._v("#")]),t._v(" trieRootOrdered")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("trieRootOrdered")]),t._v("(input: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(", codec?: "),a("em",[a("code",[t._v("Codec")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRootOrdered.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("trieRootOrdered.ts:30"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": trieRootOrdered")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a trie hash from the supplied values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Array")]),t._v(" input, calculate the ordered triehash and return the result as a "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" trieRootOrdered "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("trieRootOrdered")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doe'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'reindeer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("Uint8Array")]),t._v(">")]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),a("td",[a("code",[t._v("Codec")])]),t._v(" "),a("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/122.4129636d.js b/docs/assets/js/122.4129636d.js new file mode 100644 index 000000000..a1bbbb1e7 --- /dev/null +++ b/docs/assets/js/122.4129636d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{450:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"triepair"}})]),t._v(" "),a("h2",{attrs:{id:"triepair"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#triepair","aria-hidden":"true"}},[t._v("#")]),t._v(" TriePair")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ TriePair")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/123.390c7af8.js b/docs/assets/js/123.390c7af8.js new file mode 100644 index 000000000..520df0469 --- /dev/null +++ b/docs/assets/js/123.390c7af8.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{449:function(t,e,r){"use strict";r.r(e);var a=r(46),_=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"unhashedtrie"}})]),t._v(" "),r("h2",{attrs:{id:"unhashedtrie"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unhashedtrie","aria-hidden":"true"}},[t._v("#")]),t._v(" unhashedTrie")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unhashedTrie")]),t._v("(input: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(", codec?: "),r("em",[r("code",[t._v("Codec")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/unhashedTrie.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("unhashedTrie.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html#triepair"}},[t._v("TriePair")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" codec")]),t._v(" "),r("td",[r("code",[t._v("Codec")])]),t._v(" "),r("td",[t._v("DEFAULT_CODEC")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/126.d301e959.js b/docs/assets/js/126.d301e959.js new file mode 100644 index 000000000..8f4eb8849 --- /dev/null +++ b/docs/assets/js/126.d301e959.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{444:function(t,e,a){"use strict";a.r(e);var s=a(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"blake2ashex"}})]),t._v(" "),a("h2",{attrs:{id:"blake2ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#blake2ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("blake2AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asHex.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": blake2AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From a "),a("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string with the specified "),a("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xba80a53f981c4d0d")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("256")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/127.d0a7193e.js b/docs/assets/js/127.d0a7193e.js new file mode 100644 index 000000000..847430933 --- /dev/null +++ b/docs/assets/js/127.d0a7193e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{443:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2asu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2asu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2AsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2AsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2AsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b u8a from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a u8a with the specified "),e("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2AsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2AsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("256")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/128.f42a132c.js b/docs/assets/js/128.f42a132c.js new file mode 100644 index 000000000..284da385a --- /dev/null +++ b/docs/assets/js/128.f42a132c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{441:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2bashex"}})]),t._v(" "),e("h2",{attrs:{id:"blake2bashex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2bashex","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsHex")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asHex.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b hex string from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923'")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/129.4d3a6550.js b/docs/assets/js/129.4d3a6550.js new file mode 100644 index 000000000..def990688 --- /dev/null +++ b/docs/assets/js/129.4d3a6550.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{440:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"blake2basu8a"}})]),t._v(" "),e("h2",{attrs:{id:"blake2basu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#blake2basu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" blake2bAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("blake2bAsU8a")]),t._v("(data: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", key?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("blake2/blake2b/asU8a.ts:22"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": blake2bAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a blake2b Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From a "),e("code",[t._v("Uint8Array")]),t._v(" input, create the blake2b and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" blake2bAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("blake2bAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982')")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("data")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("512")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" key")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("null")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/130.d0dd4775.js b/docs/assets/js/130.d0dd4775.js new file mode 100644 index 000000000..9b9f6cbe2 --- /dev/null +++ b/docs/assets/js/130.d0dd4775.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{438:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"keccakashex"}})]),t._v(" "),a("h2",{attrs:{id:"keccakashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keccakashex","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("keccakAsHex")]),t._v("(value: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": keccakAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a keccak hex string from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),a("code",[t._v("0x")]),t._v(" prefixed hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/131.5391d115.js b/docs/assets/js/131.5391d115.js new file mode 100644 index 000000000..2a913c487 --- /dev/null +++ b/docs/assets/js/131.5391d115.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{437:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"keccakasu8a"}})]),t._v(" "),e("h2",{attrs:{id:"keccakasu8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#keccakasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" keccakAsU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("keccakAsU8a")]),t._v("(value: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("keccak/asU8a.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": keccakAsU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a keccak Uint8Array from the input.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": From either a "),e("code",[t._v("string")]),t._v(" or a "),e("code",[t._v("Buffer")]),t._v(" input, create the keccak and return the result as a "),e("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" keccakAsU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("keccakAsU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'123'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("value")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("string")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/132.3c1a5562.js b/docs/assets/js/132.3c1a5562.js new file mode 100644 index 000000000..d61c87a68 --- /dev/null +++ b/docs/assets/js/132.3c1a5562.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{435:function(t,e,n){"use strict";n.r(e);var a=n(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"mnemonicgenerate"}})]),t._v(" "),n("h2",{attrs:{id:"mnemonicgenerate"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicgenerate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicGenerate")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("mnemonicGenerate")]),t._v("(strength?: "),n("em",[n("code",[t._v("Strength")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/generate.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/generate.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": mnemonicGenerate")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a valid mnemonic string using using "),n("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),n("OutboundLink")],1),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" strength")]),t._v(" "),n("td",[n("code",[t._v("Strength")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/133.4d7cdad5.js b/docs/assets/js/133.4d7cdad5.js new file mode 100644 index 000000000..83d2ba817 --- /dev/null +++ b/docs/assets/js/133.4d7cdad5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{434:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tosecret"}})]),t._v(" "),r("h2",{attrs:{id:"tosecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tosecret","aria-hidden":"true"}},[t._v("#")]),t._v(" toSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toSecret")]),t._v("(mnemonic: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSecret.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSecret.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("mnemonic")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/134.175e14ba.js b/docs/assets/js/134.175e14ba.js new file mode 100644 index 000000000..69ff9f50f --- /dev/null +++ b/docs/assets/js/134.175e14ba.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{432:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"toseed"}})]),t._v(" "),s("h2",{attrs:{id:"toseed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#toseed","aria-hidden":"true"}},[t._v("#")]),t._v(" toSeed")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toSeed")]),t._v("(mnemonic: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSeed.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/toSeed.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": toSeed")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a valid seed from a mnemonic input")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicToSeed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("isValidMnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Seed generated from mnemonic: ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicToSeed")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" u8a\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("mnemonic")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/135.6c143002.js b/docs/assets/js/135.6c143002.js new file mode 100644 index 000000000..17c67af85 --- /dev/null +++ b/docs/assets/js/135.6c143002.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{431:function(t,n,a){"use strict";a.r(n);var e=a(46),s=Object(e.a)({},function(){var t=this,n=t.$createElement,a=t._self._c||n;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"mnemonicvalidate"}})]),t._v(" "),a("h2",{attrs:{id:"mnemonicvalidate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mnemonicvalidate","aria-hidden":"true"}},[t._v("#")]),t._v(" mnemonicValidate")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("mnemonicValidate")]),t._v("(mnemonic: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/validate.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("mnemonic/validate.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": mnemonicValidate")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Validates a mnemonic input using "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" mnemonicGenerate"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mnemonicValidate "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicGenerate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => string")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isValidMnemonic "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mnemonicValidate")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mnemonic"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => boolean")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("mnemonic")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/136.78afd8ff.js b/docs/assets/js/136.78afd8ff.js new file mode 100644 index 000000000..80e93c4b5 --- /dev/null +++ b/docs/assets/js/136.78afd8ff.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{429:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"nacldecrypt"}})]),t._v(" "),n("h2",{attrs:{id:"nacldecrypt"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#nacldecrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclDecrypt")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("naclDecrypt")]),t._v("(encrypted: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", nonce: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", secret: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/decrypt.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/decrypt.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": naclDecrypt")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Decrypts a message using the supplied secretKey and nonce")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns an decrypted message, using the "),n("code",[t._v("secret")]),t._v(" and "),n("code",[t._v("nonce")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclDecrypt "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclDecrypt")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("encrypted")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("nonce")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("secret")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/137.347ff027.js b/docs/assets/js/137.347ff027.js new file mode 100644 index 000000000..9b33aba3a --- /dev/null +++ b/docs/assets/js/137.347ff027.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{428:function(t,n,e){"use strict";e.r(n);var a=e(46),s=Object(a.a)({},function(){var t=this,n=t.$createElement,e=t._self._c||n;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclencrypt"}})]),t._v(" "),e("h2",{attrs:{id:"naclencrypt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclencrypt","aria-hidden":"true"}},[t._v("#")]),t._v(" naclEncrypt")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclEncrypt")]),t._v("(message: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", secret: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(", nonce?: "),e("em",[e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("Encrypted")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/encrypt.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/encrypt.ts:28"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclEncrypt")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Encrypts a message using the supplied secretKey and nonce")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns an encrypted message, using the "),e("code",[t._v("secretKey")]),t._v(" and "),e("code",[t._v("nonce")]),t._v(". If the "),e("code",[t._v("nonce")]),t._v(" was not supplied, a random value is generated.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclEncrypt "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclEncrypt")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("message")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[t._v("secret")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" nonce")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")])]),t._v(" "),e("td",[t._v("randomAsU8a(24)")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Encrypted")])]),t._v(" "),e("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/138.df837b4b.js b/docs/assets/js/138.df837b4b.js new file mode 100644 index 000000000..448bf2cf7 --- /dev/null +++ b/docs/assets/js/138.df837b4b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{426:function(t,a,e){"use strict";e.r(a);var r=e(46),n=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"naclkeypairfromrandom"}})]),t._v(" "),e("h2",{attrs:{id:"naclkeypairfromrandom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromrandom","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromRandom")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("naclKeypairFromRandom")]),t._v("(): "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromRandom.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": naclKeypairFromRandom")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns a new generate object containing a "),e("code",[t._v("publicKey")]),t._v(" & "),e("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromRandom "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromRandom")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/139.65c63374.js b/docs/assets/js/139.65c63374.js new file mode 100644 index 000000000..047f790e4 --- /dev/null +++ b/docs/assets/js/139.65c63374.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{425:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromsecret"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromsecret"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromsecret","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromSecret")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromSecret")]),t._v("(secret: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromSecret.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromSecret")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied secret.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromSecret "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromSecret")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("secret")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/14.cdf62cb8.js b/docs/assets/js/14.cdf62cb8.js new file mode 100644 index 000000000..19e990be8 --- /dev/null +++ b/docs/assets/js/14.cdf62cb8.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{418:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": DiskDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Disk database using LruDb (for caching with FileFlatDb) and extending TransactionDb. Note that LruDB uses the "),n("a",{attrs:{href:"https://www.npmjs.com/package/lru_map",target:"_blank",rel:"noopener noreferrer"}},[t._v("Least Recently Used (LRU) cache algorithm"),n("OutboundLink")],1)]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" DiskDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Disk'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat diskDb instance that wraps LruDb with backing and Lru cache")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" diskDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("DiskDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Creat txDb instance that uses diskDb")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the disk db backing database. Clears the Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in disk db backing and also in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from disk db. Returns cached value if key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cache, otherwise returns backing value for key and stores")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this latest retrieved key/value pair in Lru cache")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from disk db backing and set the key to null in Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from diskDb db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("diskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the diskDb database and clear Lru cache")]),t._v("\ndiskDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ DiskDb")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new DiskDb")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", name: "),n("em",[n("code",[t._v("string")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Disk.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Disk.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("name")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/140.51d65b0e.js b/docs/assets/js/140.51d65b0e.js new file mode 100644 index 000000000..049b5229b --- /dev/null +++ b/docs/assets/js/140.51d65b0e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{423:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),a("p",[a("a",{attrs:{id:"naclkeypairfromseed"}})]),e._v(" "),a("h2",{attrs:{id:"naclkeypairfromseed"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" naclKeypairFromSeed")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("naclKeypairFromSeed")]),e._v("(seed: "),a("em",[a("code",[e._v("Uint8Array")])]),e._v("): "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("nacl/keypair/fromSeed.ts:23"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("em",[a("strong",[e._v("name")])]),e._v(": naclKeypairFromSeed")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("summary")])]),e._v(": Creates a new public/secret keypair from a seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("description")])]),e._v(": Returns a object containing a "),a("code",[e._v("publicKey")]),e._v(" & "),a("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),a("p",[a("em",[a("strong",[e._v("example")])]),e._v(":")]),e._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("import")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" naclKeypairFromSeed "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("from")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("naclKeypairFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// => { secretKey: [...], publicKey: [...] }")]),e._v("\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br"),a("span",{staticClass:"line-number"},[e._v("3")]),a("br")])]),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("seed")]),e._v(" "),a("td",[a("code",[e._v("Uint8Array")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/141.f9a51cbf.js b/docs/assets/js/141.f9a51cbf.js new file mode 100644 index 000000000..ce70a58c5 --- /dev/null +++ b/docs/assets/js/141.f9a51cbf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{419:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"naclkeypairfromstring"}})]),t._v(" "),r("h2",{attrs:{id:"naclkeypairfromstring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#naclkeypairfromstring","aria-hidden":"true"}},[t._v("#")]),t._v(" naclKeypairFromString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("naclKeypairFromString")]),t._v("(value: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromString.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/keypair/fromString.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": naclKeypairFromString")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Creates a new public/secret keypair from a string.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a object containing a "),r("code",[t._v("publicKey")]),t._v(" & "),r("code",[t._v("secretKey")]),t._v(" generated from the supplied string. The string is hashed and the value used as the input seed.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclKeypairFromString "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclKeypairFromString")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => { secretKey: [...], publicKey: [...] }")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[t._v("KeypairType")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/142.6d88dd71.js b/docs/assets/js/142.6d88dd71.js new file mode 100644 index 000000000..362450681 --- /dev/null +++ b/docs/assets/js/142.6d88dd71.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{422:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclsign"}})]),t._v(" "),a("h2",{attrs:{id:"naclsign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclsign","aria-hidden":"true"}},[t._v("#")]),t._v(" naclSign")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclSign")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", __namedParameters: "),a("em",[a("code",[t._v("object")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/sign.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/sign.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Signs a message using the supplied secretKey")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns message signature of "),a("code",[t._v("message")]),t._v(", using the "),a("code",[t._v("secretKey")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclSign "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclSign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [...]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("__namedParameters")]),t._v(" "),a("td",[a("code",[t._v("object")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/143.4026d731.js b/docs/assets/js/143.4026d731.js new file mode 100644 index 000000000..56cd47cd4 --- /dev/null +++ b/docs/assets/js/143.4026d731.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{420:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"naclverify"}})]),t._v(" "),a("h2",{attrs:{id:"naclverify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#naclverify","aria-hidden":"true"}},[t._v("#")]),t._v(" naclVerify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("naclVerify")]),t._v("(message: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", signature: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v(", publicKey: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/verify.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("nacl/verify.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": naclSign")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Verifies the signature on the supplied message.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Verifies the "),a("code",[t._v("signature")]),t._v(" on "),a("code",[t._v("message")]),t._v(" with the supplied "),a("code",[t._v("plublicKey")]),t._v(". Returns "),a("code",[t._v("true")]),t._v(" on sucess, "),a("code",[t._v("false")]),t._v(" otherwise.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" naclVerify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("naclVerify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true/false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("signature")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("tr",[a("td",[t._v("publicKey")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/144.22f9176e.js b/docs/assets/js/144.22f9176e.js new file mode 100644 index 000000000..fd3fb8964 --- /dev/null +++ b/docs/assets/js/144.22f9176e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{417:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomashex"}})]),t._v(" "),a("h2",{attrs:{id:"randomashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomashex","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsHex")]),t._v("(length?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a hex string filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a hex string with the specified (optional) length filled with random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x...")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("32")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/145.5b4bc4d5.js b/docs/assets/js/145.5b4bc4d5.js new file mode 100644 index 000000000..41f5a9e44 --- /dev/null +++ b/docs/assets/js/145.5b4bc4d5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{416:function(t,s,a){"use strict";a.r(s);var r=a(46),n=Object(r.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"randomasnumber"}})]),t._v(" "),a("h2",{attrs:{id:"randomasnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#randomasnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("randomAsNumber")]),t._v("(): "),a("code",[t._v("number")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asNumber.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asNumber.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": randomAsNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a random number from random bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a random number generated from the secure bytes.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => ")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("number")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/146.af7eed4e.js b/docs/assets/js/146.af7eed4e.js new file mode 100644 index 000000000..662a9d4d8 --- /dev/null +++ b/docs/assets/js/146.af7eed4e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{414:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"randomasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"randomasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#randomasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" randomAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("randomAsU8a")]),t._v("(length?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("random/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": randomAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified (optional) length filled with random bytes.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" length")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("32")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/147.ee00a155.js b/docs/assets/js/147.ee00a155.js new file mode 100644 index 000000000..aff06259c --- /dev/null +++ b/docs/assets/js/147.ee00a155.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{413:function(e,r,t){"use strict";t.r(r);var o=t(46),s=Object(o.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelkeypairfromseed"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelkeypairfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelkeypairfromseed","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelKeypairFromSeed")]),e._v("(seed: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/keypair/fromSeed.ts:16"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelKeypairFromSeed")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Returns a object containing a "),t("code",[e._v("publicKey")]),e._v(" & "),t("code",[e._v("secretKey")]),e._v(" generated from the supplied seed.")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("seed")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/util-crypto/modules/_types_.html#keypairtype"}},[e._v("KeypairType")])],1),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/148.9f987a2b.js b/docs/assets/js/148.9f987a2b.js new file mode 100644 index 000000000..25cdef7e3 --- /dev/null +++ b/docs/assets/js/148.9f987a2b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{411:function(r,e,t){"use strict";t.r(e);var a=t(46),o=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[r._v("#")]),r._v(" Functions")]),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelisready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelisready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelisready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelIsReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelIsReady")]),r._v("(): "),t("code",[r._v("boolean")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:11"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("boolean")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelwaitready"}})]),r._v(" "),t("h2",{attrs:{id:"schnorrkelwaitready"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelwaitready","aria-hidden":"true"}},[r._v("#")]),r._v(" schnorrkelWaitReady")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("schnorrkelWaitReady")]),r._v("(): "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[r._v("schnorrkel/ready.ts:7"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Promise")]),r._v("<"),t("code",[r._v("boolean")]),r._v(">")]),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/149.cad6b842.js b/docs/assets/js/149.cad6b842.js new file mode 100644 index 000000000..4e5da1ac7 --- /dev/null +++ b/docs/assets/js/149.cad6b842.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{410:function(e,t,r){"use strict";r.r(t);var s=r(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"schnorrkelsign"}})]),e._v(" "),r("h2",{attrs:{id:"schnorrkelsign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelsign","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelSign")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("schnorrkelSign")]),e._v("(message: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", __namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/sign.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/sign.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": schnorrkelSign")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns message signature of "),r("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("message")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/15.06d67387.js b/docs/assets/js/15.06d67387.js new file mode 100644 index 000000000..cf45926ce --- /dev/null +++ b/docs/assets/js/15.06d67387.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{400:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("FileTreeDb")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new FileTreeDb")]),e._v("(location: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("location")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"_location"}})]),e._v(" "),r("h2",{attrs:{id:"location"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#location","aria-hidden":"true"}},[e._v("#")]),e._v(" _location")]),e._v(" "),r("p",[r("strong",[e._v("● _location")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),e._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[e._v("#")]),e._v(" close")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("close")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[e._v("close")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),e._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[e._v("#")]),e._v(" del")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("del")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[e._v("del")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:76"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),e._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[e._v("#")]),e._v(" drop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("drop")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[e._v("drop")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),e._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[e._v("#")]),e._v(" empty")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("empty")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[e._v("empty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),e._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[e._v("#")]),e._v(" get")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("get")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[e._v("get")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:86"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),e._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[e._v("#")]),e._v(" maintain")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("maintain")]),e._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[e._v("maintain")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("fn")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[e._v("ProgressCb")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),e._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[e._v("#")]),e._v(" open")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("open")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[e._v("open")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),e._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[e._v("#")]),e._v(" put")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("put")]),e._v("(key: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[e._v("put")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:100"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),e._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[e._v("#")]),e._v(" rename")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("rename")]),e._v("(base: "),r("em",[r("code",[e._v("string")])]),e._v(", file: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[e._v("rename")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("base")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("file")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),e._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[e._v("#")]),e._v(" size")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("size")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[e._v("BaseDb")]),e._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[e._v("size")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("engines/FileTreeDb.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/151.07167f62.js b/docs/assets/js/151.07167f62.js new file mode 100644 index 000000000..bd4c68015 --- /dev/null +++ b/docs/assets/js/151.07167f62.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[151],{408:function(e,r,t){"use strict";t.r(r);var n=t(46),s=Object(n.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"schnorrkelverify"}})]),e._v(" "),t("h2",{attrs:{id:"schnorrkelverify"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schnorrkelverify","aria-hidden":"true"}},[e._v("#")]),e._v(" schnorrkelVerify")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("schnorrkelVerify")]),e._v("(message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", publicKey: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v("): "),t("code",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/verify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("schnorrkel/verify.ts:11"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": schnorrkelVerify")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Verifies the signature of "),t("code",[e._v("message")]),e._v(", using the supplied pair")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("publicKey")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("boolean")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/152.45295d3e.js b/docs/assets/js/152.45295d3e.js new file mode 100644 index 000000000..578863a0b --- /dev/null +++ b/docs/assets/js/152.45295d3e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{405:function(e,r,t){"use strict";t.r(r);var v=t(46),s=Object(v.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"secp256k1recover"}})]),e._v(" "),t("h2",{attrs:{id:"secp256k1recover"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#secp256k1recover","aria-hidden":"true"}},[e._v("#")]),e._v(" secp256k1Recover")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("secp256k1Recover")]),e._v("(_message: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", _signature: "),t("em",[t("code",[e._v("Uint8Array")])]),e._v(", recovery: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/secp256k1/recover.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("secp256k1/recover.ts:12"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("em",[t("strong",[e._v("name")])]),e._v(": secp256k1Recover")]),e._v(" "),t("p",[t("em",[t("strong",[e._v("description")])]),e._v(": Recovers a publicKey from the supplied signature")]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("_message")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("_signature")]),e._v(" "),t("td",[t("code",[e._v("Uint8Array")])])]),e._v(" "),t("tr",[t("td",[e._v("recovery")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("Uint8Array")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/153.b09d25ec.js b/docs/assets/js/153.b09d25ec.js new file mode 100644 index 000000000..93ef45026 --- /dev/null +++ b/docs/assets/js/153.b09d25ec.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{404:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"sha512asu8a"}})]),t._v(" "),s("h2",{attrs:{id:"sha512asu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sha512asu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" sha512AsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("sha512AsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/sha512/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("sha512/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": sha512AsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates sha-512 hash of the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a sha-512 "),s("code",[t._v("Uint8Array")]),t._v(" from the supplied data.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" sha512AsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sha512AsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Uint8Array"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([...])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/154.dcf40e55.js b/docs/assets/js/154.dcf40e55.js new file mode 100644 index 000000000..5e61f3e09 --- /dev/null +++ b/docs/assets/js/154.dcf40e55.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[154],{402:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"keypairtype"}})]),t._v(" "),a("h2",{attrs:{id:"keypairtype"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keypairtype","aria-hidden":"true"}},[t._v("#")]),t._v(" KeypairType")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ KeypairType")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/155.e8630fed.js b/docs/assets/js/155.e8630fed.js new file mode 100644 index 000000000..8d7e79e41 --- /dev/null +++ b/docs/assets/js/155.e8630fed.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[155],{401:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashashex"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashashex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsHex")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asHex.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a hex string with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/156.cd310ab3.js b/docs/assets/js/156.cd310ab3.js new file mode 100644 index 000000000..2293f9ca9 --- /dev/null +++ b/docs/assets/js/156.cd310ab3.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{399:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhashasu8a"}})]),t._v(" "),s("h2",{attrs:{id:"xxhashasu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhashasu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhashAsU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhashAsU8a")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asU8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/asU8a.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhashAsU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash64 u8a from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash64 and return the result as a "),s("code",[t._v("Uint8Array")]),t._v(" with the specified "),s("code",[t._v("bitLength")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhashAsU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhashAsU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x44bc2cf5ad770999")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("64")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/157.fbb601cd.js b/docs/assets/js/157.fbb601cd.js new file mode 100644 index 000000000..581e9681c --- /dev/null +++ b/docs/assets/js/157.fbb601cd.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{398:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64asbn"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64asbn"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asbn","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsBn")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsBn")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("BN")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asBn.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsBn")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash BN from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a BN.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsBn")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => new BN(0xe29f70f8b8c96df7)")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("BN")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/158.2d59a307.js b/docs/assets/js/158.2d59a307.js new file mode 100644 index 000000000..c94cb8609 --- /dev/null +++ b/docs/assets/js/158.2d59a307.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{395:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"xxhash64ashex"}})]),t._v(" "),a("h2",{attrs:{id:"xxhash64ashex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64ashex","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("xxhash64AsHex")]),t._v("(data: "),a("em",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", seed: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asHex.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": xxhash64AsHex")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a xxhash hex from the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From either a "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("Uint8Array")]),t._v(" or a "),a("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex string.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsHex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0xe29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("data")]),t._v(" "),a("td",[a("code",[t._v("Buffer")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("seed")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/159.c5393dcf.js b/docs/assets/js/159.c5393dcf.js new file mode 100644 index 000000000..a0ec2c52f --- /dev/null +++ b/docs/assets/js/159.c5393dcf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{396:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asraw"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asraw"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asraw","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsRaw")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsRaw")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asRaw.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsRaw")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a xxhash non-prefixed hex from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a non-prefixed hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsRaw "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsRaw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/16.f65ce986.js b/docs/assets/js/16.f65ce986.js new file mode 100644 index 000000000..ce3534f83 --- /dev/null +++ b/docs/assets/js/16.f65ce986.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{403:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("LruDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new LruDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(", itemCount?: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" itemCount")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("DEFAULT_ITEM_COUNT")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"_getlru"}})]),t._v(" "),r("h2",{attrs:{id:"getlru"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getlru","aria-hidden":"true"}},[t._v("#")]),t._v(" _getLru")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("_getLru")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("CachedValue")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:91"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/LruDb.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/160.9d78b704.js b/docs/assets/js/160.9d78b704.js new file mode 100644 index 000000000..e3a0119f6 --- /dev/null +++ b/docs/assets/js/160.9d78b704.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{393:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"xxhash64asvalue"}})]),t._v(" "),s("h2",{attrs:{id:"xxhash64asvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#xxhash64asvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" xxhash64AsValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("xxhash64AsValue")]),t._v("(data: "),s("em",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", seed: "),s("em",[s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("xxhash/xxhash64/asValue.ts:22"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": xxhash64AsValue")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex number from the input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": From either a "),s("code",[t._v("string")]),t._v(", "),s("code",[t._v("Uint8Array")]),t._v(" or a "),s("code",[t._v("Buffer")]),t._v(" input, create the xxhash and return the result as a hex number")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" xxhash64AsValue "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("xxhash64AsValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abcd'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xabcd")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => e29f70f8b8c96df7")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("data")]),t._v(" "),s("td",[s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])])]),t._v(" "),s("tr",[s("td",[t._v("seed")]),t._v(" "),s("td",[s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/161.7cf36eee.js b/docs/assets/js/161.7cf36eee.js new file mode 100644 index 000000000..eafe3eb0b --- /dev/null +++ b/docs/assets/js/161.7cf36eee.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[161],{392:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-util-rlp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util-rlp","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util-rlp")]),t._v(" "),a("p",[t._v("Utility methods for encoding and decoding "),a("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/%5BEnglish%5D-RLP",target:"_blank",rel:"noopener noreferrer"}},[t._v("Ethereum RLP structures"),a("OutboundLink")],1),t._v(". This is port adapted from the original "),a("a",{attrs:{href:"https://github.com/ethereumjs/rlp/blob/0ce09db81fc303fcee593f7cc094ba44015f9b92/index.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("EthereumJS RLP"),a("OutboundLink")],1),t._v(" implementation to cater for "),a("code",[t._v("Uint8Array")]),t._v(" outputs (instead of "),a("code",[t._v("Buffer")]),t._v(") in addition to typings.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/util-rlp\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Functions can be imported as follows:")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" decode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" encode "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-rlp'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/util-rlp/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/162.44f64348.js b/docs/assets/js/162.44f64348.js new file mode 100644 index 000000000..5802398af --- /dev/null +++ b/docs/assets/js/162.44f64348.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{390:function(t,e,l){"use strict";l.r(e);var r=l(46),o=Object(r.a)({},function(){var t=this,e=t.$createElement,l=t._self._c||e;return l("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[l("ul",[l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decode_.html"}},[t._v('"decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_decode_.html"}},[t._v('"decoder/decode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listlong_.html"}},[t._v('"decoder/listLong"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_listshort_.html"}},[t._v('"decoder/listShort"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_number_.html"}},[t._v('"decoder/number"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_safeparseint_.html"}},[t._v('"decoder/safeParseInt"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_single_.html"}},[t._v('"decoder/single"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_string_.html"}},[t._v('"decoder/string"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html"}},[t._v('"decoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encode_.html"}},[t._v('"encode"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_array_.html"}},[t._v('"encoder/array"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_length_.html"}},[t._v('"encoder/length"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_tou8a_.html"}},[t._v('"encoder/toU8a"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html"}},[t._v('"encoder/types"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/util-rlp/modules/_encoder_u8a_.html"}},[t._v('"encoder/u8a"')])],1)])])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/163.6d8d5318.js b/docs/assets/js/163.6d8d5318.js new file mode 100644 index 000000000..a89ccbdac --- /dev/null +++ b/docs/assets/js/163.6d8d5318.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{387:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/164.5c07ac11.js b/docs/assets/js/164.5c07ac11.js new file mode 100644 index 000000000..ebb715862 --- /dev/null +++ b/docs/assets/js/164.5c07ac11.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{389:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),t._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[t._v("#")]),t._v(" decode")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decode")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/decode.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/decode.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/165.3ea85802.js b/docs/assets/js/165.3ea85802.js new file mode 100644 index 000000000..052b4ad32 --- /dev/null +++ b/docs/assets/js/165.3ea85802.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{386:function(t,e,o){"use strict";o.r(e);var r=o(46),d=Object(r.a)({},function(){var t=this,e=t.$createElement,o=t._self._c||e;return o("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[o("h1",{attrs:{id:"functions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),o("p",[o("a",{attrs:{id:"decodelistlong"}})]),t._v(" "),o("h2",{attrs:{id:"decodelistlong"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#decodelistlong","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListLong")]),t._v(" "),o("p",[t._v("▸ "),o("strong",[t._v("decodeListLong")]),t._v("(decode: "),o("em",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),o("em",[o("code",[t._v("Uint8Array")])]),t._v("): "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("p",[o("em",[t._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listLong.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listLong.ts:11"),o("OutboundLink")],1)])]),t._v(" "),o("p",[o("strong",[t._v("Parameters:")])]),t._v(" "),o("table",[o("thead",[o("tr",[o("th",[t._v("Name")]),t._v(" "),o("th",[t._v("Type")])])]),t._v(" "),o("tbody",[o("tr",[o("td",[t._v("decode")]),t._v(" "),o("td",[o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),o("tr",[o("td",[t._v("input")]),t._v(" "),o("td",[o("code",[t._v("Uint8Array")])])])])]),t._v(" "),o("p",[o("strong",[t._v("Returns:")]),t._v(" "),o("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),o("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/166.e8c681e5.js b/docs/assets/js/166.e8c681e5.js new file mode 100644 index 000000000..b6003672c --- /dev/null +++ b/docs/assets/js/166.e8c681e5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{384:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodelistshort"}})]),t._v(" "),r("h2",{attrs:{id:"decodelistshort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodelistshort","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeListShort")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeListShort")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listShort.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/listShort.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/167.ba95f807.js b/docs/assets/js/167.ba95f807.js new file mode 100644 index 000000000..d03415bff --- /dev/null +++ b/docs/assets/js/167.ba95f807.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{383:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodenumber"}})]),e._v(" "),r("h2",{attrs:{id:"decodenumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenumber","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNumber")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/number.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/number.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/168.99af1574.js b/docs/assets/js/168.99af1574.js new file mode 100644 index 000000000..86652d0f5 --- /dev/null +++ b/docs/assets/js/168.99af1574.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{381:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"safeparseint"}})]),t._v(" "),r("h2",{attrs:{id:"safeparseint"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#safeparseint","aria-hidden":"true"}},[t._v("#")]),t._v(" safeParseInt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("safeParseInt")]),t._v("(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/safeParseInt.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/safeParseInt.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/169.3a3e8489.js b/docs/assets/js/169.3a3e8489.js new file mode 100644 index 000000000..85ee72f5c --- /dev/null +++ b/docs/assets/js/169.3a3e8489.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{380:function(e,t,r){"use strict";r.r(t);var o=r(46),d=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodesingle"}})]),e._v(" "),r("h2",{attrs:{id:"decodesingle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodesingle","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeSingle")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeSingle")]),e._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1),e._v(", input: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/single.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("decoder/single.ts:7"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("decode")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[e._v("DecodeFunc")])],1)]),e._v(" "),r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[e._v("DecodeOutput")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/17.66687909.js b/docs/assets/js/17.66687909.js new file mode 100644 index 000000000..e0afa7118 --- /dev/null +++ b/docs/assets/js/17.66687909.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{409:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("MemoryDb")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MemoryDb")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:62"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/MemoryDb.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/170.50e773a0.js b/docs/assets/js/170.50e773a0.js new file mode 100644 index 000000000..16a36034f --- /dev/null +++ b/docs/assets/js/170.50e773a0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{378:function(t,e,r){"use strict";r.r(e);var o=r(46),d=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodestring"}})]),t._v(" "),r("h2",{attrs:{id:"decodestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodestring","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeString")]),t._v("(decode: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/string.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/string.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("decode")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodefunc"}},[t._v("DecodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/171.2c1f7987.js b/docs/assets/js/171.2c1f7987.js new file mode 100644 index 000000000..0a2d40a21 --- /dev/null +++ b/docs/assets/js/171.2c1f7987.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{377:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodefunc"}})]),t._v(" "),r("h2",{attrs:{id:"decodefunc"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeFunc")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeFunc")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/util-rlp/modules/_decoder_types_.html#decodeoutput"}},[t._v("DecodeOutput")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeoutput"}})]),t._v(" "),r("h2",{attrs:{id:"decodeoutput"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeoutput","aria-hidden":"true"}},[t._v("#")]),t._v(" DecodeOutput")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DecodeOutput")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("decoder/types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/172.d6fe72c8.js b/docs/assets/js/172.d6fe72c8.js new file mode 100644 index 000000000..2fff5e35f --- /dev/null +++ b/docs/assets/js/172.d6fe72c8.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{375:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/173.fa8116ca.js b/docs/assets/js/173.fa8116ca.js new file mode 100644 index 000000000..73273040e --- /dev/null +++ b/docs/assets/js/173.fa8116ca.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[173],{374:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodearray"}})]),t._v(" "),r("h2",{attrs:{id:"encodearray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodearray","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeArray")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/array.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/array.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/174.cd35051f.js b/docs/assets/js/174.cd35051f.js new file mode 100644 index 000000000..cc4b83731 --- /dev/null +++ b/docs/assets/js/174.cd35051f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{372:function(e,t,n){"use strict";n.r(t);var r=n(46),o=Object(r.a)({},function(){var e=this,t=e.$createElement,n=e._self._c||t;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),n("p",[n("a",{attrs:{id:"encodelength"}})]),e._v(" "),n("h2",{attrs:{id:"encodelength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#encodelength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeLength")]),e._v(" "),n("p",[e._v("▸ "),n("strong",[e._v("encodeLength")]),e._v("(length: "),n("em",[n("code",[e._v("number")])]),e._v(", offset: "),n("em",[n("code",[e._v("number")])]),e._v("): "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("p",[n("em",[e._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/length.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("encoder/length.ts:7"),n("OutboundLink")],1)])]),e._v(" "),n("p",[n("strong",[e._v("Parameters:")])]),e._v(" "),n("table",[n("thead",[n("tr",[n("th",[e._v("Name")]),e._v(" "),n("th",[e._v("Type")])])]),e._v(" "),n("tbody",[n("tr",[n("td",[e._v("length")]),e._v(" "),n("td",[n("code",[e._v("number")])])]),e._v(" "),n("tr",[n("td",[e._v("offset")]),e._v(" "),n("td",[n("code",[e._v("number")])])])])]),e._v(" "),n("p",[n("strong",[e._v("Returns:")]),e._v(" "),n("code",[e._v("Uint8Array")])]),e._v(" "),n("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/175.d225e122.js b/docs/assets/js/175.d225e122.js new file mode 100644 index 000000000..698fa8dea --- /dev/null +++ b/docs/assets/js/175.d225e122.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[175],{370:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"tou8a"}})]),t._v(" "),a("h2",{attrs:{id:"tou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/toU8a.ts:39"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/176.037c9c6a.js b/docs/assets/js/176.037c9c6a.js new file mode 100644 index 000000000..f677be6b8 --- /dev/null +++ b/docs/assets/js/176.037c9c6a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{371:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"encodefunc"}})]),t._v(" "),a("h2",{attrs:{id:"encodefunc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#encodefunc","aria-hidden":"true"}},[t._v("#")]),t._v(" EncodeFunc")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ EncodeFunc")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(input: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/177.25bdd03b.js b/docs/assets/js/177.25bdd03b.js new file mode 100644 index 000000000..f7f946a43 --- /dev/null +++ b/docs/assets/js/177.25bdd03b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{369:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"encodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" encodeU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encodeU8a")]),t._v("(encoder: "),r("em",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1),t._v(", input: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/u8a.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("encoder/u8a.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("encoder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/util-rlp/modules/_encoder_types_.html#encodefunc"}},[t._v("EncodeFunc")])],1)]),t._v(" "),r("tr",[r("td",[t._v("input")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/178.15534701.js b/docs/assets/js/178.15534701.js new file mode 100644 index 000000000..2533645b6 --- /dev/null +++ b/docs/assets/js/178.15534701.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{368:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-util"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util")]),t._v(" "),s("p",[t._v("Various useful utility functions that are used across all projects in the "),s("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("@polkadot"),s("OutboundLink")],1),t._v(" namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.")]),t._v(" "),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),s("p",[t._v("Installation -")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("yarn add @polkadot/util\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("p",[t._v("Functions can be imported directly from the package, e.g.")]),t._v(" "),s("div",{staticClass:"language-js line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("h2",{attrs:{id:"utilities"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),s("p",[s("router-link",{attrs:{to:"/util/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/18.d8e7daec.js b/docs/assets/js/18.d8e7daec.js new file mode 100644 index 000000000..94ec34fb7 --- /dev/null +++ b/docs/assets/js/18.d8e7daec.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{406:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("TransactionDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new TransactionDb")]),t._v("(backing: "),r("em",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("backing")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/180.d0d7416a.js b/docs/assets/js/180.d0d7416a.js new file mode 100644 index 000000000..147522875 --- /dev/null +++ b/docs/assets/js/180.d0d7416a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{362:function(t,r,e){"use strict";e.r(r);var a=e(46),s=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": ExtError")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Extension to the basic JS Error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal "),e("code",[t._v("stack")]),t._v(", "),e("code",[t._v("message")]),t._v(", the numeric "),e("code",[t._v("code")]),t._v(" and "),e("code",[t._v("data")]),t._v(" (any types) parameters are available on the object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ExtError "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("throw")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ExtError")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some message'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ExtError"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CODES")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("METHOD_NOT_FOUND")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => error.code = -32601")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("code",[t._v("Error")])]),t._v(" "),e("p",[e("strong",[t._v("↳ ExtError")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1)]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new ExtError")]),t._v("(message?: "),e("em",[e("code",[t._v("string")])]),t._v(", code?: "),e("em",[e("code",[t._v("number")])]),t._v(", data?: "),e("em",[e("code",[t._v("any")])]),t._v("): "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" message")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v('""')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("UNKNOWN")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),e("td",[e("code",[t._v("any")])]),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"code"}})]),t._v(" "),e("h2",{attrs:{id:"code"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),e("p",[e("strong",[t._v("● code")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#code"}},[t._v("code")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:35"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"data"}})]),t._v(" "),e("h2",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[e("strong",[t._v("● data")]),t._v(": "),e("em",[e("code",[t._v("any")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#data"}},[t._v("data")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:37"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"message"}})]),t._v(" "),e("h2",{attrs:{id:"message"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),e("p",[e("strong",[t._v("● message")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#message"}},[t._v("message")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.message")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:39"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"name"}})]),t._v(" "),e("h2",{attrs:{id:"name"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),e("p",[e("strong",[t._v("● name")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.name")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:41"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"stack"}})]),t._v(" "),e("h2",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[e("strong",[t._v("● stack")]),t._v(": "),e("em",[e("code",[t._v("string")])])]),t._v(" "),e("p",[e("em",[t._v("Implementation of "),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")]),t._v("."),e("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html#stack"}},[t._v("stack")])],1)]),t._v(" "),e("p",[e("em",[t._v("Overrides Error.stack")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"error"}})]),t._v(" "),e("h2",{attrs:{id:"static-error"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-error","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" Error")]),t._v(" "),e("p",[e("strong",[t._v("● Error")]),t._v(": "),e("em",[e("code",[t._v("ErrorConstructor")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984")])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"object-literals"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#object-literals","aria-hidden":"true"}},[t._v("#")]),t._v(" Object literals")]),t._v(" "),e("p",[e("a",{attrs:{id:"codes"}})]),t._v(" "),e("h2",{attrs:{id:"static-codes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#static-codes","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" CODES")]),t._v(" "),e("p",[e("strong",[t._v("CODES")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:60"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("a",{attrs:{id:"codes.assert"}})]),t._v(" "),e("h3",{attrs:{id:"assert"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" ASSERT")]),t._v(" "),e("p",[e("strong",[t._v("● ASSERT")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -90009")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:61"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.invalid_jsonrpc"}})]),t._v(" "),e("h3",{attrs:{id:"invalid-jsonrpc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#invalid-jsonrpc","aria-hidden":"true"}},[t._v("#")]),t._v(" INVALID_JSONRPC")]),t._v(" "),e("p",[e("strong",[t._v("● INVALID_JSONRPC")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -99998")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:63"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.method_not_found"}})]),t._v(" "),e("h3",{attrs:{id:"method-not-found"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#method-not-found","aria-hidden":"true"}},[t._v("#")]),t._v(" METHOD_NOT_FOUND")]),t._v(" "),e("p",[e("strong",[t._v("● METHOD_NOT_FOUND")]),t._v(": "),e("em",[e("code",[t._v("number")])]),t._v(" = -32601")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:64"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"codes.unknown"}})]),t._v(" "),e("h3",{attrs:{id:"unknown"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unknown","aria-hidden":"true"}},[t._v("#")]),t._v(" UNKNOWN")]),t._v(" "),e("p",[e("strong",[t._v("● UNKNOWN")]),t._v(": "),e("em",[e("code",[t._v("number")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("ext/error.ts:62"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/181.265ffcde.js b/docs/assets/js/181.265ffcde.js new file mode 100644 index 000000000..989826c8b --- /dev/null +++ b/docs/assets/js/181.265ffcde.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{366:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("ExtErrorInterface")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"code"}})]),t._v(" "),r("h2",{attrs:{id:"code"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),r("p",[r("strong",[t._v("● code")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("● data")]),t._v(": "),r("em",[r("code",[t._v("any")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"message"}})]),t._v(" "),r("h2",{attrs:{id:"message"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#message","aria-hidden":"true"}},[t._v("#")]),t._v(" message")]),t._v(" "),r("p",[r("strong",[t._v("● message")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"stack"}})]),t._v(" "),r("h2",{attrs:{id:"stack"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stack","aria-hidden":"true"}},[t._v("#")]),t._v(" stack")]),t._v(" "),r("p",[r("strong",[t._v("● stack")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/182.17aac8ce.js b/docs/assets/js/182.17aac8ce.js new file mode 100644 index 000000000..310e75a59 --- /dev/null +++ b/docs/assets/js/182.17aac8ce.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{365:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ToBnOptions")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"isle"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isle","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isLe")]),e._v(" "),r("p",[r("strong",[e._v("● isLe")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:24"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnegative"}})]),e._v(" "),r("h2",{attrs:{id:"optional-isnegative"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-isnegative","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" isNegative")]),e._v(" "),r("p",[r("strong",[e._v("● isNegative")]),e._v(": "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/183.497b2283.js b/docs/assets/js/183.497b2283.js new file mode 100644 index 000000000..6ded1af4e --- /dev/null +++ b/docs/assets/js/183.497b2283.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{364:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"arrayfilter"}})]),t._v(" "),s("h2",{attrs:{id:"arrayfilter"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#arrayfilter","aria-hidden":"true"}},[t._v("#")]),t._v(" arrayFilter")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("arrayFilter")]),t._v("(array: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(", allowNulls?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/array/filter.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("array/filter.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": arrayFilter")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Filters undefined and (optionally) null values from an array")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a new array with all "),s("code",[t._v("undefined")]),t._v(" values removed. Optionally, when "),s("code",[t._v("allowNulls = false")]),t._v(", it removes the "),s("code",[t._v("null")]),t._v(" values as well")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" arrayFilter "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, null, false, '']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("arrayFilter")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0, true, false, '']")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("array")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" allowNulls")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("true")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("any")]),t._v(">")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/184.478a891c.js b/docs/assets/js/184.478a891c.js new file mode 100644 index 000000000..d2305e94c --- /dev/null +++ b/docs/assets/js/184.478a891c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{363:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"assert"}})]),t._v(" "),a("h2",{attrs:{id:"assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" assert")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("assert")]),t._v("<"),a("code",[t._v("T")]),t._v(">(test: "),a("em",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(", message: "),a("em",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(", code?: "),a("em",[a("code",[t._v("number")])]),t._v(", data?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/assert.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("assert.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": assert")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Checks for a valid test, if not ExtError is thrown.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks that "),a("code",[t._v("test")]),t._v(" is a truthy value. If value is falsy ("),a("code",[t._v("null")]),t._v(", "),a("code",[t._v("undefined")]),t._v(", "),a("code",[t._v("false")]),t._v(", ...), it throws an ExtError with the supplied "),a("code",[t._v("message")]),t._v(" and an optional "),a("code",[t._v("code")]),t._v(" and "),a("code",[t._v("data")]),t._v(". When "),a("code",[t._v("test")]),t._v(" passes, "),a("code",[t._v("true")]),t._v(" is returned.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'True should be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// true returned")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'False should not be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError thrown")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError with 'message'")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Type parameters:")])]),t._v(" "),a("h4",{attrs:{id:"t"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("test")]),t._v(" "),a("td",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("ExtError.CODES.ASSERT")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),a("td",[a("code",[t._v("any")])]),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/185.6c3879cf.js b/docs/assets/js/185.6c3879cf.js new file mode 100644 index 000000000..4346a0301 --- /dev/null +++ b/docs/assets/js/185.6c3879cf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{361:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/186.77a23514.js b/docs/assets/js/186.77a23514.js new file mode 100644 index 000000000..8732b0e0f --- /dev/null +++ b/docs/assets/js/186.77a23514.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{360:function(t,n,s){"use strict";s.r(n);var a=s(46),e=Object(a.a)({},function(){var t=this,n=t.$createElement,s=t._self._c||n;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntobn"}})]),t._v(" "),s("h2",{attrs:{id:"bntobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntobn","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToBn")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toBn.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toBn.ts:23"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN value from a BN.js bignumber or number input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x0")]),t._v(" result, BN values returns the value, numnbers returns a BN representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToBn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x1234)")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/187.765f81a4.js b/docs/assets/js/187.765f81a4.js new file mode 100644 index 000000000..741a35169 --- /dev/null +++ b/docs/assets/js/187.765f81a4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{359:function(t,e,s){"use strict";s.r(e);var n=s(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bntohex"}})]),t._v(" "),s("h2",{attrs:{id:"bntohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bntohex","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bnToHex")]),t._v("(value?: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(", options?: "),s("em",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toHex.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toHex.ts:33"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": bnToHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a hex value from a BN.js bignumber object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("0x")]),t._v(" result, BN values return the actual value as a "),s("code",[t._v("0x")]),t._v(" prefixed hex value. Anything that is not a BN object throws an error. With "),s("code",[t._v("bitLength")]),t._v(" set, it fixes the number to the specified length.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x123456")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x123456'")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("code",[t._v("number")]),t._v(" | "),s("code",[t._v("Options")])]),t._v(" "),s("td",[t._v("{ bitLength: -1, isLe: false, isNegative: false }")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/188.348a5174.js b/docs/assets/js/188.348a5174.js new file mode 100644 index 000000000..a426492b3 --- /dev/null +++ b/docs/assets/js/188.348a5174.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{358:function(t,e,n){"use strict";n.r(e);var a=n(46),v=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"bntou8a"}})]),t._v(" "),n("h2",{attrs:{id:"bntou8a"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bntou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bnToU8a")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("code",[t._v("Options")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bnToU8a")]),t._v("(value: "),n("em",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])]),t._v(", isLe?: "),n("em",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": bnToU8a")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a BN.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("Uint8Array")]),t._v(" result. "),n("code",[t._v("BN")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("Uint8Array")]),t._v(". Optionally convert using little-endian format if "),n("code",[t._v("isLE")]),t._v(" is set.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bnToU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("bnToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("code",[t._v("Options")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("bn/toU8a.ts:30"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("BN")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("number")])])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" isLe")]),t._v(" "),n("td",[n("code",[t._v("undefined")]),t._v(" | "),n("code",[t._v("false")]),t._v(" | "),n("code",[t._v("true")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/189.68693ae1.js b/docs/assets/js/189.68693ae1.js new file mode 100644 index 000000000..accf946f8 --- /dev/null +++ b/docs/assets/js/189.68693ae1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{357:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"buffertou8a"}})]),t._v(" "),e("h2",{attrs:{id:"buffertou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buffertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" bufferToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("bufferToU8a")]),t._v("(buffer?: "),e("em",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/buffer/toU8a.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("buffer/toU8a.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": bufferToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Buffer object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty result, "),e("code",[t._v("Buffer")]),t._v(" values return the actual value as a "),e("code",[t._v("Uint8Array")]),t._v(". Anything that is not a "),e("code",[t._v("Buffer")]),t._v(" object throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bufferToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("bufferToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" buffer")]),t._v(" "),e("td",[e("code",[t._v("Buffer")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/19.abe0aba9.js b/docs/assets/js/19.abe0aba9.js new file mode 100644 index 000000000..20584c9f2 --- /dev/null +++ b/docs/assets/js/19.abe0aba9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{412:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Cache")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Cache")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/190.5992cf8d.js b/docs/assets/js/190.5992cf8d.js new file mode 100644 index 000000000..459131c5e --- /dev/null +++ b/docs/assets/js/190.5992cf8d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{356:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactaddlength"}})]),t._v(" "),s("h2",{attrs:{id:"compactaddlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactaddlength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactAddLength")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactAddLength")]),t._v("(input: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/addLength.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/addLength.ts:20"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactAddLength")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Adds a length prefix to the input value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactAddLength "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactAddLength")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xbe")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xef")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/191.9561b139.js b/docs/assets/js/191.9561b139.js new file mode 100644 index 000000000..0859fd2fc --- /dev/null +++ b/docs/assets/js/191.9561b139.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{355:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"default_bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"const-default-bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-default-bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" DEFAULT_BITLENGTH")]),t._v(" "),a("p",[a("strong",[t._v("● DEFAULT_BITLENGTH")]),t._v(": "),a("em",[a("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" = 32")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/defaults.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/defaults.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/192.f7cb00e8.js b/docs/assets/js/192.f7cb00e8.js new file mode 100644 index 000000000..f0dc95733 --- /dev/null +++ b/docs/assets/js/192.f7cb00e8.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[192],{354:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compactfromu8a"}})]),t._v(" "),s("h2",{attrs:{id:"compactfromu8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compactfromu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactFromU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactFromU8a")]),t._v("(_input: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(", bitLength?: "),s("em",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/fromU8a.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/fromU8a.ts:26"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactFromU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Retrievs the offset and encoded length from a compact-prefixed value")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactFromU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactFromU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("254")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("255")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'value offset='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" offset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'length='")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4, 0xffff")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_input")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),s("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" ["),s("code",[t._v("number")]),t._v(", "),s("code",[t._v("BN")]),t._v("]")]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/193.ec9dac13.js b/docs/assets/js/193.ec9dac13.js new file mode 100644 index 000000000..fd366f31f --- /dev/null +++ b/docs/assets/js/193.ec9dac13.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{353:function(t,a,n){"use strict";n.r(a);var s=n(46),e=Object(s.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"compactstriplength"}})]),t._v(" "),n("h2",{attrs:{id:"compactstriplength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#compactstriplength","aria-hidden":"true"}},[t._v("#")]),t._v(" compactStripLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("compactStripLength")]),t._v("(input: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v("): ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/stripLength.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/stripLength.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": compactStripLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactStripLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactStripLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<<")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xde")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xad")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [2, Uint8Array[0xde, 0xad]]")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("input")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/modules/_compact_types_.html#bitlength"}},[t._v("BitLength")])],1),t._v(" "),n("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" ["),n("code",[t._v("number")]),t._v(", "),n("code",[t._v("Uint8Array")]),t._v("]")]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/194.91654e88.js b/docs/assets/js/194.91654e88.js new file mode 100644 index 000000000..e13fff50f --- /dev/null +++ b/docs/assets/js/194.91654e88.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{351:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"compacttou8a"}})]),t._v(" "),s("h2",{attrs:{id:"compacttou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#compacttou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" compactToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("compactToU8a")]),t._v("(_value: "),s("em",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": compactToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Encodes a number into a compact representation")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" compactToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("compactToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("511")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0b11111101, 0b00000111])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_value")]),t._v(" "),s("td",[s("code",[t._v("BN")]),t._v(" | "),s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/195.1089c5be.js b/docs/assets/js/195.1089c5be.js new file mode 100644 index 000000000..3c2b5950e --- /dev/null +++ b/docs/assets/js/195.1089c5be.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[195],{352:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"bitlength"}})]),t._v(" "),a("h2",{attrs:{id:"bitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" BitLength")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ BitLength")]),t._v(": "),a("em",[a("code",[t._v("8")]),t._v(" | "),a("code",[t._v("16")]),t._v(" | "),a("code",[t._v("32")]),t._v(" | "),a("code",[t._v("64")]),t._v(" | "),a("code",[t._v("128")]),t._v(" | "),a("code",[t._v("256")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("compact/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/196.46524ef0.js b/docs/assets/js/196.46524ef0.js new file mode 100644 index 000000000..87ef870f3 --- /dev/null +++ b/docs/assets/js/196.46524ef0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{350:function(t,r,e){"use strict";e.r(r);var s=e(46),a=Object(s.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/197.72ae4804.js b/docs/assets/js/197.72ae4804.js new file mode 100644 index 000000000..6c05b0d92 --- /dev/null +++ b/docs/assets/js/197.72ae4804.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{349:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hexaddprefix"}})]),t._v(" "),s("h2",{attrs:{id:"hexaddprefix"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hexaddprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexAddPrefix")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexAddPrefix")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/addPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/addPrefix.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexAddPrefix")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Adds the "),s("code",[t._v("0x")]),t._v(" prefix to string values.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("0x")]),t._v(" prefixed string from the input value. If the input is already prefixed, it is returned unchanged.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexAddPrefix "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'With prefix'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexAddPrefix")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0a0b12'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0a0b12")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/198.67fc5eb5.js b/docs/assets/js/198.67fc5eb5.js new file mode 100644 index 000000000..2b05c3535 --- /dev/null +++ b/docs/assets/js/198.67fc5eb5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[198],{348:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hexfixlength"}})]),t._v(" "),n("h2",{attrs:{id:"hexfixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hexfixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" hexFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("string")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", withPadding?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/fixLength.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/fixLength.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a hex string to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a "),n("code",[t._v("0x")]),t._v(" prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When "),n("code",[t._v("withPadding")]),t._v(" is set, shorter values are padded with "),n("code",[t._v("0")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fixed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x0012'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("string")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" withPadding")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/199.24cd895b.js b/docs/assets/js/199.24cd895b.js new file mode 100644 index 000000000..c3a85ab30 --- /dev/null +++ b/docs/assets/js/199.24cd895b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{346:function(t,s,e){"use strict";e.r(s);var a=e(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexhasprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexhasprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexhasprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexHasPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexHasPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/hasPrefix.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/hasPrefix.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexHasPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Checks for a valid hex input value and if the start matched "),e("code",[t._v("0x")])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexHasPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'has prefix'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexHasPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/20.fec34c17.js b/docs/assets/js/20.fec34c17.js new file mode 100644 index 000000000..bb8727886 --- /dev/null +++ b/docs/assets/js/20.fec34c17.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{415:function(t,r,a){"use strict";a.r(r);var e=a(46),s=Object(e.a)({},function(){var t=this,r=t.$createElement,a=t._self._c||r;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("Compact")])]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new Compact")]),t._v("(file: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:17"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("file")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"maintain"}})]),t._v(" "),a("h2",{attrs:{id:"maintain"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("maintain")]),t._v("(fn: "),a("em",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Compact.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/200.06ea278f.js b/docs/assets/js/200.06ea278f.js new file mode 100644 index 000000000..cf275a489 --- /dev/null +++ b/docs/assets/js/200.06ea278f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[200],{347:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hexstripprefix"}})]),t._v(" "),e("h2",{attrs:{id:"hexstripprefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hexstripprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" hexStripPrefix")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexStripPrefix")]),t._v("(value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/stripPrefix.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/stripPrefix.ts:23"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexStripPrefix")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Strips any leading "),e("code",[t._v("0x")]),t._v(" prefix.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Tests for the existence of a "),e("code",[t._v("0x")]),t._v(" prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexStripPrefix "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'stripped'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexStripPrefix")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 1234")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/201.69833266.js b/docs/assets/js/201.69833266.js new file mode 100644 index 000000000..1d5c92b94 --- /dev/null +++ b/docs/assets/js/201.69833266.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{345:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"hextobn"}})]),t._v(" "),n("h2",{attrs:{id:"hextobn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hextobn","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("hexToBn")]),t._v("(value?: "),n("em",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", options?: "),n("em",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v("): "),n("code",[t._v("BN")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toBn.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toBn.ts:35"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": hexToBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a BN.js bignumber object from a hex string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v(" inputs returns a "),n("code",[t._v("BN(0)")]),t._v(" result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the "),n("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => BN(0x123480001f)")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("string")]),t._v(" | "),n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),n("code",[t._v("boolean")])],1),t._v(" "),n("td",[t._v("{ isLe: false, isNegative: false }")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("BN")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/202.5eecc4e9.js b/docs/assets/js/202.5eecc4e9.js new file mode 100644 index 000000000..11cb37332 --- /dev/null +++ b/docs/assets/js/202.5eecc4e9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{344:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"hextonumber"}})]),t._v(" "),s("h2",{attrs:{id:"hextonumber"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hextonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToNumber")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("hexToNumber")]),t._v("(value?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toNumber.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toNumber.ts:21"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": hexToNumber")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Number value from a Buffer object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns an NaN result, "),s("code",[t._v("hex")]),t._v(" values return the actual value as a "),s("code",[t._v("Number")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToNumber "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToNumber")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x1234")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/203.36b81107.js b/docs/assets/js/203.36b81107.js new file mode 100644 index 000000000..2fcf2bbc7 --- /dev/null +++ b/docs/assets/js/203.36b81107.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{343:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"hextou8a"}})]),t._v(" "),e("h2",{attrs:{id:"hextou8a"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hextou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" hexToU8a")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hexToU8a")]),t._v("(_value?: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toU8a.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("hex/toU8a.ts:24"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": hexToU8a")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Uint8Array")]),t._v(" result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the "),e("code",[t._v("0x")]),t._v(" prefix) throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" hexToU8a "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x80, 0x00, 0x1f])")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hexToU8a")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x80001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Uint8Array([0x00, 0x80, 0x00, 0x1f])")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Uint8Array")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/204.d6cc92ca.js b/docs/assets/js/204.d6cc92ca.js new file mode 100644 index 000000000..4ebf8a538 --- /dev/null +++ b/docs/assets/js/204.d6cc92ca.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{342:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isbn"}})]),t._v(" "),n("h2",{attrs:{id:"isbn"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isbn","aria-hidden":"true"}},[t._v("#")]),t._v(" isBn")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isBn")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/bn.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/bn.ts:22"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isBn")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("BN")]),t._v(" object instance.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),n("code",[t._v("BN")]),t._v(" (bn.js).")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BN")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bn.js'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBn "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBn'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBn")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BN")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/205.b8a7e0cb.js b/docs/assets/js/205.b8a7e0cb.js new file mode 100644 index 000000000..e6f50143a --- /dev/null +++ b/docs/assets/js/205.b8a7e0cb.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{341:function(t,a,s){"use strict";s.r(a);var e=s(46),n=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"isboolean"}})]),t._v(" "),s("h2",{attrs:{id:"isboolean"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isboolean","aria-hidden":"true"}},[t._v("#")]),t._v(" isBoolean")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isBoolean")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/boolean.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/boolean.ts:19"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isBoolean")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a boolean value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript boolean.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBoolean "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBoolean")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/206.d65748de.js b/docs/assets/js/206.d65748de.js new file mode 100644 index 000000000..e02948a38 --- /dev/null +++ b/docs/assets/js/206.d65748de.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{340:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isbuffer"}})]),t._v(" "),a("h2",{attrs:{id:"isbuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isbuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" isBuffer")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isBuffer")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/buffer.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/buffer.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isBuffer")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Buffer")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Buffer")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isBuffer "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isBuffer'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isBuffer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/207.27a83dc0.js b/docs/assets/js/207.27a83dc0.js new file mode 100644 index 000000000..699dd0ae2 --- /dev/null +++ b/docs/assets/js/207.27a83dc0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[207],{339:function(t,s,r){"use strict";r.r(s);var a=r(46),n=Object(a.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"iserror"}})]),t._v(" "),r("h2",{attrs:{id:"iserror"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iserror","aria-hidden":"true"}},[t._v("#")]),t._v(" isError")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("isError")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/error.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/error.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": isError")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Tests for a "),r("code",[t._v("Error")]),t._v(" object instance.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),r("code",[t._v("Error")]),t._v(".")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isError "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isError'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("isError")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/208.33c2f481.js b/docs/assets/js/208.33c2f481.js new file mode 100644 index 000000000..394a915f5 --- /dev/null +++ b/docs/assets/js/208.33c2f481.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{338:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isfunction"}})]),t._v(" "),n("h2",{attrs:{id:"isfunction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" isFunction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isFunction")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/function.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/function.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isFunction")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("function")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript function.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isFunction "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFunction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/209.8498127e.js b/docs/assets/js/209.8498127e.js new file mode 100644 index 000000000..6a5b7e441 --- /dev/null +++ b/docs/assets/js/209.8498127e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[209],{337:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"ishex"}})]),t._v(" "),s("h2",{attrs:{id:"ishex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ishex","aria-hidden":"true"}},[t._v("#")]),t._v(" isHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isHex")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v(", bitLength?: "),s("em",[s("code",[t._v("number")])]),t._v(", ignoreLength?: "),s("em",[s("code",[t._v("boolean")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/hex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/hex.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": isHex")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Tests for a hex string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a "),s("code",[t._v("0x")]),t._v(" prefixed hex string. Optionally ("),s("code",[t._v("bitLength")]),t._v(" !== -1) checks to see if the bitLength is correct.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isHex "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])]),t._v(" "),s("td",[t._v("-")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[t._v("-1")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" ignoreLength")]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[t._v("false")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/21.33f3c84a.js b/docs/assets/js/21.33f3c84a.js new file mode 100644 index 000000000..873a86bf2 --- /dev/null +++ b/docs/assets/js/21.33f3c84a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{302:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[t._v("Serialize")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ File")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new File")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/File.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/File.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/210.55deda89.js b/docs/assets/js/210.55deda89.js new file mode 100644 index 000000000..aac854660 --- /dev/null +++ b/docs/assets/js/210.55deda89.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{336:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isinstanceof"}})]),t._v(" "),a("h2",{attrs:{id:"isinstanceof"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isinstanceof","aria-hidden":"true"}},[t._v("#")]),t._v(" isInstanceOf")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isInstanceOf")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v(", clazz: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/instanceOf.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/instanceOf.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isInstanceOf")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a instance of a class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is an instance of the test class.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isInstanceOf "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isInstanceOf'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isInstanceOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Array"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("clazz")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/211.7e86d5ba.js b/docs/assets/js/211.7e86d5ba.js new file mode 100644 index 000000000..95f26cf2a --- /dev/null +++ b/docs/assets/js/211.7e86d5ba.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[211],{335:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isip"}})]),t._v(" "),a("h2",{attrs:{id:"isip"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isip","aria-hidden":"true"}},[t._v("#")]),t._v(" isIp")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isIp")]),t._v("(value: "),a("em",[a("code",[t._v("string")])]),t._v(", type?: "),a("em",[a("code",[t._v("IpTypes")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/ip.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/ip.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isIp")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests if the value is a valid IP address")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the value is a valid IP address. Optionally check for either v4/v6")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isIp "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'192.168.0.1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v6'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIp")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1:2:3:4:5:6:7:8'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'v4'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" type")]),t._v(" "),a("td",[a("code",[t._v("IpTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/212.d7390e95.js b/docs/assets/js/212.d7390e95.js new file mode 100644 index 000000000..e06759045 --- /dev/null +++ b/docs/assets/js/212.d7390e95.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{334:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnull"}})]),t._v(" "),a("h2",{attrs:{id:"isnull"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[t._v("#")]),t._v(" isNull")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNull")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/null.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/null.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNull")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("null")]),t._v(" values.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),a("code",[t._v("null")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNull "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNull'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNull")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/213.693cbd68.js b/docs/assets/js/213.693cbd68.js new file mode 100644 index 000000000..c731324ce --- /dev/null +++ b/docs/assets/js/213.693cbd68.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[213],{333:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isnumber"}})]),t._v(" "),a("h2",{attrs:{id:"isnumber"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" isNumber")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isNumber")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/number.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/number.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isNumber")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a JavaScript number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a valid number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isNumber "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isNumber'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/214.b58aaf1c.js b/docs/assets/js/214.b58aaf1c.js new file mode 100644 index 000000000..a38f77fdc --- /dev/null +++ b/docs/assets/js/214.b58aaf1c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{332:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isobject"}})]),t._v(" "),a("h2",{attrs:{id:"isobject"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobject","aria-hidden":"true"}},[t._v("#")]),t._v(" isObject")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isObject")]),t._v("(value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/object.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/object.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isObject")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for an "),a("code",[t._v("object")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript object.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isObject "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'something'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/215.b803123d.js b/docs/assets/js/215.b803123d.js new file mode 100644 index 000000000..c496cfa93 --- /dev/null +++ b/docs/assets/js/215.b803123d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{331:function(s,t,a){"use strict";a.r(t);var e=a(46),n=Object(e.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[s._v("#")]),s._v(" Functions")]),s._v(" "),a("p",[a("a",{attrs:{id:"isobservable"}})]),s._v(" "),a("h2",{attrs:{id:"isobservable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isobservable","aria-hidden":"true"}},[s._v("#")]),s._v(" isObservable")]),s._v(" "),a("p",[s._v("▸ "),a("strong",[s._v("isObservable")]),s._v("(value: "),a("em",[a("code",[s._v("any")])]),s._v("): "),a("code",[s._v("boolean")])]),s._v(" "),a("p",[a("em",[s._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/observable.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[s._v("is/observable.ts:26"),a("OutboundLink")],1)])]),s._v(" "),a("p",[a("em",[a("strong",[s._v("name")])]),s._v(": isBObservable")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("summary")])]),s._v(": Tests for a "),a("code",[s._v("Observable")]),s._v(" object instance.")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("description")])]),s._v(": Checks to see if the input object is an instance of "),a("code",[s._v("BN")]),s._v(" (bn.js).")]),s._v(" "),a("p",[a("em",[a("strong",[s._v("example")])]),s._v(":")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" isObservable "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'isObservable'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("isObservable")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br")])]),a("p",[a("strong",[s._v("Parameters:")])]),s._v(" "),a("table",[a("thead",[a("tr",[a("th",[s._v("Name")]),s._v(" "),a("th",[s._v("Type")])])]),s._v(" "),a("tbody",[a("tr",[a("td",[s._v("value")]),s._v(" "),a("td",[a("code",[s._v("any")])])])])]),s._v(" "),a("p",[a("strong",[s._v("Returns:")]),s._v(" "),a("code",[s._v("boolean")])]),s._v(" "),a("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/216.e6d7df8e.js b/docs/assets/js/216.e6d7df8e.js new file mode 100644 index 000000000..2e5973eca --- /dev/null +++ b/docs/assets/js/216.e6d7df8e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{330:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isstring"}})]),t._v(" "),n("h2",{attrs:{id:"isstring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isstring","aria-hidden":"true"}},[t._v("#")]),t._v(" isString")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isString")]),t._v("(value: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/string.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/string.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isString")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is a JavaScript string.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isString "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isString'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/217.f1faffcf.js b/docs/assets/js/217.f1faffcf.js new file mode 100644 index 000000000..a9e6052ad --- /dev/null +++ b/docs/assets/js/217.f1faffcf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{329:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"isu8a"}})]),t._v(" "),a("h2",{attrs:{id:"isu8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" isU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("isU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/u8a.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/u8a.ts:21"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": isU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Tests for a "),a("code",[t._v("Uint8Array")]),t._v(" object instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks to see if the input object is an instance of "),a("code",[t._v("Uint8Array")]),t._v(".")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUint8Array "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => false")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/218.b545b399.js b/docs/assets/js/218.b545b399.js new file mode 100644 index 000000000..85f5b2930 --- /dev/null +++ b/docs/assets/js/218.b545b399.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{328:function(t,s,n){"use strict";n.r(s);var e=n(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"isundefined"}})]),t._v(" "),n("h2",{attrs:{id:"isundefined"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#isundefined","aria-hidden":"true"}},[t._v("#")]),t._v(" isUndefined")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("isUndefined")]),t._v("(value?: "),n("em",[n("code",[t._v("any")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/undefined.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("is/undefined.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": isUndefined")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Tests for a "),n("code",[t._v("undefined")]),t._v(" values.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks to see if the input value is "),n("code",[t._v("undefined")]),t._v(".")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" isUndefined "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'isUndefined'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("isUndefined")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("void")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => true")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("any")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/219.d691d2fa.js b/docs/assets/js/219.d691d2fa.js new file mode 100644 index 000000000..004a47451 --- /dev/null +++ b/docs/assets/js/219.d691d2fa.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{327:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"format"}})]),t._v(" "),s("h2",{attrs:{id:"format"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#format","aria-hidden":"true"}},[t._v("#")]),t._v(" format")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("format")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("any")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:42"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"logger"}})]),t._v(" "),s("h2",{attrs:{id:"logger"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" logger")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("logger")]),t._v("(_type: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("logger.ts:104"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": Logger")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a consistent log interface for messages")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a "),s("code",[t._v("Logger")]),t._v(" that has "),s("code",[t._v(".log")]),t._v(", "),s("code",[t._v(".error")]),t._v(", "),s("code",[t._v(".warn")]),t._v(" and "),s("code",[t._v(".debug")]),t._v(" (controlled with environment "),s("code",[t._v("DEBUG=typeA,typeB")]),t._v(") methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" l "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/logger'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'test'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blah'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// TEST: blah")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("_type")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/22.b3e519f1.js b/docs/assets/js/22.b3e519f1.js new file mode 100644 index 000000000..13f7cf828 --- /dev/null +++ b/docs/assets/js/22.b3e519f1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{540:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Impl")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Impl")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")]),t._v("."),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/Cache.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/220.732ab40d.js b/docs/assets/js/220.732ab40d.js new file mode 100644 index 000000000..5ea3cbf9f --- /dev/null +++ b/docs/assets/js/220.732ab40d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{326:function(t,e,n){"use strict";n.r(e);var s=n(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"numbertohex"}})]),t._v(" "),n("h2",{attrs:{id:"numbertohex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#numbertohex","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToHex")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("numberToHex")]),t._v("(value?: "),n("em",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toHex.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toHex.ts:24"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": numberToHex")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a hex value from a number.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": "),n("code",[t._v("null")]),t._v("/"),n("code",[t._v("undefined")]),t._v("/"),n("code",[t._v("NaN")]),t._v(" inputs returns an empty "),n("code",[t._v("0x")]),t._v(" result. "),n("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),n("code",[t._v("hex")]),t._v(". With "),n("code",[t._v("bitLength")]),t._v(" set, it converts the number to the equivalent size.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToHex "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => '0x1234'")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x00001234")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),n("td",[n("code",[t._v("number")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/221.3ab0b29e.js b/docs/assets/js/221.3ab0b29e.js new file mode 100644 index 000000000..ed77a9802 --- /dev/null +++ b/docs/assets/js/221.3ab0b29e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{325:function(t,e,a){"use strict";a.r(e);var n=a(46),r=Object(n.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"numbertou8a"}})]),t._v(" "),a("h2",{attrs:{id:"numbertou8a"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#numbertou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" numberToU8a")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("numberToU8a")]),t._v("(value?: "),a("em",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(", bitLength?: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toU8a.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("number/toU8a.ts:22"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": numberToU8a")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a number.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("null")]),t._v("/"),a("code",[t._v("undefined")]),t._v("/"),a("code",[t._v("NaN")]),t._v(" inputs returns an empty "),a("code",[t._v("Uint8Array")]),t._v(" result. "),a("code",[t._v("number")]),t._v(" input values return the actual bytes value converted to a "),a("code",[t._v("Uint8Array")]),t._v(". With "),a("code",[t._v("bitLength")]),t._v(", it converts the value to the equivalent size.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" numberToU8a "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => [0x12, 0x34]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("-1")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/222.b6d99e16.js b/docs/assets/js/222.b6d99e16.js new file mode 100644 index 000000000..86a890ea5 --- /dev/null +++ b/docs/assets/js/222.b6d99e16.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{324:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/224.30f758f2.js b/docs/assets/js/224.30f758f2.js new file mode 100644 index 000000000..2031007b9 --- /dev/null +++ b/docs/assets/js/224.30f758f2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{323:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/225.93a35929.js b/docs/assets/js/225.93a35929.js new file mode 100644 index 000000000..64b3045b9 --- /dev/null +++ b/docs/assets/js/225.93a35929.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{321:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/226.8dea9412.js b/docs/assets/js/226.8dea9412.js new file mode 100644 index 000000000..1b2a26fa4 --- /dev/null +++ b/docs/assets/js/226.8dea9412.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{320:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/228.3374c974.js b/docs/assets/js/228.3374c974.js new file mode 100644 index 000000000..abcfa4cfe --- /dev/null +++ b/docs/assets/js/228.3374c974.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{318:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"promisify"}})]),t._v(" "),a("h2",{attrs:{id:"promisify"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#promisify","aria-hidden":"true"}},[t._v("#")]),t._v(" promisify")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("promisify")]),t._v("(self: "),a("em",[a("code",[t._v("any")])]),t._v(", fn: "),a("em",[a("code",[t._v("Function")])]),t._v(", ...params: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/promisify.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("promisify.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": promisify")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Wraps an async callback into a "),a("code",[t._v("Promise")])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Wraps the supplied async function "),a("code",[t._v("fn")]),t._v(" that has a standard JS callback "),a("code",[t._v("(error: Error, result: any)")]),t._v(" into a "),a("code",[t._v("Promise")]),t._v(", passing the supplied parameters. When "),a("code",[t._v("error")]),t._v(" is set, the Promise is rejected, else the Promise resolves with the "),a("code",[t._v("result")]),t._v(" value.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" promisify "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" a"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resolves with `true`")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("promisify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("cb")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'error!'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rejects with `error!`")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("self")]),t._v(" "),a("td",[a("code",[t._v("any")])])]),t._v(" "),a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("code",[t._v("Function")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" params")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Promise")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/229.168cc500.js b/docs/assets/js/229.168cc500.js new file mode 100644 index 000000000..0546a2ab4 --- /dev/null +++ b/docs/assets/js/229.168cc500.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{317:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/230.67d69ce6.js b/docs/assets/js/230.67d69ce6.js new file mode 100644 index 000000000..ba7cfdee4 --- /dev/null +++ b/docs/assets/js/230.67d69ce6.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{316:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringlowerfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringlowerfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringlowerfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringLowerFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringLowerFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/lowerFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/lowerFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringLowerFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringLowerFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringLowerFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ABC'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'aBC'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/231.b3ed861d.js b/docs/assets/js/231.b3ed861d.js new file mode 100644 index 000000000..9231aaeac --- /dev/null +++ b/docs/assets/js/231.b3ed861d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{315:function(t,s,n){"use strict";n.r(s);var e=n(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"stringshorten"}})]),t._v(" "),n("h2",{attrs:{id:"stringshorten"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stringshorten","aria-hidden":"true"}},[t._v("#")]),t._v(" stringShorten")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("stringShorten")]),t._v("(_value?: "),n("em",[n("code",[t._v("any")])]),t._v(", prefixLength?: "),n("em",[n("code",[t._v("number")])]),t._v("): "),n("code",[t._v("string")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/shorten.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/shorten.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": stringShorten")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Returns a string with maximum length")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Checks the string against the "),n("code",[t._v("prefixLength")]),t._v(", if longer than dopuble this, shortens it by placing "),n("code",[t._v("..")]),t._v(" in the middle of it")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringShorten "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringShorten")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1234567890'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 12..90")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),n("td",[n("code",[t._v("any")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" prefixLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("6")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("string")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/232.67759a82.js b/docs/assets/js/232.67759a82.js new file mode 100644 index 000000000..0df709318 --- /dev/null +++ b/docs/assets/js/232.67759a82.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{314:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"stringtou8a"}})]),t._v(" "),s("h2",{attrs:{id:"stringtou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#stringtou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" stringToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("stringToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/toU8a.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/toU8a.ts:39"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": stringToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array object from a utf-8 string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": String input values return the actual encoded "),s("code",[t._v("UInt8Array")]),t._v(". "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty encoded array.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hello'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0x68, 0x65, 0x6c, 0x6c, 0x6f]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/233.6411d217.js b/docs/assets/js/233.6411d217.js new file mode 100644 index 000000000..048ab39bd --- /dev/null +++ b/docs/assets/js/233.6411d217.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[233],{313:function(t,s,r){"use strict";r.r(s);var e=r(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"stringupperfirst"}})]),t._v(" "),r("h2",{attrs:{id:"stringupperfirst"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stringupperfirst","aria-hidden":"true"}},[t._v("#")]),t._v(" stringUpperFirst")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stringUpperFirst")]),t._v("(value?: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/upperFirst.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("string/upperFirst.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": stringUpperFirst")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("summary")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Lowercase the first letter of a string")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("example")])]),t._v(":")]),t._v(" "),r("div",{staticClass:"language-javascript line-numbers-mode"},[r("pre",{pre:!0,attrs:{class:"language-javascript"}},[r("code",[r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringUpperFirst "),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringUpperFirst")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'abc'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 'Abc'")]),t._v("\n")])]),t._v(" "),r("div",{staticClass:"line-numbers-wrapper"},[r("span",{staticClass:"line-number"},[t._v("1")]),r("br"),r("span",{staticClass:"line-number"},[t._v("2")]),r("br"),r("span",{staticClass:"line-number"},[t._v("3")]),r("br")])]),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/234.215b2134.js b/docs/assets/js/234.215b2134.js new file mode 100644 index 000000000..5f34e0735 --- /dev/null +++ b/docs/assets/js/234.215b2134.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{312:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"syncify"}})]),t._v(" "),n("h2",{attrs:{id:"syncify"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#syncify","aria-hidden":"true"}},[t._v("#")]),t._v(" syncify")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("syncify")]),t._v("(promise: "),n("em",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")]),t._v("): "),n("code",[t._v("any")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/syncify.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("syncify.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("promise")]),t._v(" "),n("td",[n("code",[t._v("Promise")]),t._v("<"),n("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("any")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/235.bb6bf091.js b/docs/assets/js/235.bb6bf091.js new file mode 100644 index 000000000..61d383117 --- /dev/null +++ b/docs/assets/js/235.bb6bf091.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{311:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")])],1)]),t._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger"}},[t._v("Logger")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/util/modules/_types_.html#logger_data"}},[t._v("Logger$Data")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"logger"}})]),t._v(" "),a("h2",{attrs:{id:"logger"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"logger_data"}})]),t._v(" "),a("h2",{attrs:{id:"logger-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#logger-data","aria-hidden":"true"}},[t._v("#")]),t._v(" Logger$Data")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ Logger$Data")]),t._v(": "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(" | "),a("code",[t._v("Logger$Data$Fn")]),t._v(">")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/236.a1743b72.js b/docs/assets/js/236.a1743b72.js new file mode 100644 index 000000000..74b7310e2 --- /dev/null +++ b/docs/assets/js/236.a1743b72.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{310:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8aconcat"}})]),t._v(" "),s("h2",{attrs:{id:"u8aconcat"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8aconcat","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aConcat")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aConcat")]),t._v("(..._list: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/concat.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/concat.ts:24"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aConcat")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a concatenated Uint8Array from the inputs.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Concatenates the input arrays into a single "),s("code",[t._v("UInt8Array")]),t._v(".")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aConcat "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aConcat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [1, 2, 3, 4, 5, 6]")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Rest")]),t._v(" _list")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(">")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/237.cf91c6d9.js b/docs/assets/js/237.cf91c6d9.js new file mode 100644 index 000000000..e622f66ea --- /dev/null +++ b/docs/assets/js/237.cf91c6d9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{309:function(t,a,n){"use strict";n.r(a);var e=n(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"u8afixlength"}})]),t._v(" "),n("h2",{attrs:{id:"u8afixlength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#u8afixlength","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aFixLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("u8aFixLength")]),t._v("(value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),n("em",[n("code",[t._v("number")])]),t._v(", atStart?: "),n("em",[n("code",[t._v("boolean")])]),t._v("): "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/fixLength.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/fixLength.ts:21"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": u8aFixLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Shifts a Uint8Array to a specific bitLength")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aFixLength "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x12'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x0012")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aFixLength")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => 0x12")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")]),t._v(" "),n("th",[t._v("Default value")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])]),t._v(" "),n("td",[t._v("-")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),n("td",[n("code",[t._v("number")])]),t._v(" "),n("td",[t._v("-1")])]),t._v(" "),n("tr",[n("td",[n("code",[t._v("Default value")]),t._v(" atStart")]),t._v(" "),n("td",[n("code",[t._v("boolean")])]),t._v(" "),n("td",[t._v("false")])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/238.daad0e47.js b/docs/assets/js/238.daad0e47.js new file mode 100644 index 000000000..8c114ac81 --- /dev/null +++ b/docs/assets/js/238.daad0e47.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{308:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atobn"}})]),t._v(" "),s("h2",{attrs:{id:"u8atobn"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atobn","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBn")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToBn")]),t._v("(value: "),s("em",[s("code",[t._v("Uint8Array")])]),t._v(", options?: "),s("em",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v("): "),s("code",[t._v("BN")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBn.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBn.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToBn")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a BN from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual BN. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an "),s("code",[t._v("0x0")]),t._v(" value.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBn "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")])]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("The value to convert")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),s("td",[s("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")]),t._v(" | "),s("code",[t._v("boolean")])],1),t._v(" "),s("td",[t._v("{ isLe: true, isNegative: false }")]),t._v(" "),s("td",[t._v("Options to pass while converting")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("BN")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/239.140e9afc.js b/docs/assets/js/239.140e9afc.js new file mode 100644 index 000000000..a2132cf82 --- /dev/null +++ b/docs/assets/js/239.140e9afc.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{307:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atobuffer"}})]),t._v(" "),e("h2",{attrs:{id:"u8atobuffer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atobuffer","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToBuffer")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToBuffer")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v("): "),e("code",[t._v("Buffer")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBuffer.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toBuffer.ts:19"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToBuffer")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a Buffer object from a hex string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("null")]),t._v(" inputs returns an empty "),e("code",[t._v("Buffer")]),t._v(" result. "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual bytes value converted to a "),e("code",[t._v("Buffer")]),t._v(". Anything that is not a "),e("code",[t._v("UInt8Array")]),t._v(" throws an error.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToBuffer "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Buffer'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToBuffer")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123480001f'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Buffer")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/24.cde54b27.js b/docs/assets/js/24.cde54b27.js new file mode 100644 index 000000000..157eecf83 --- /dev/null +++ b/docs/assets/js/24.cde54b27.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{427:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": MemoryDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Creates a MemoryDb database extending TransactionDb")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Create an instance of a Memory database using MemoryDb and extending TransactionDb. "),n("code",[t._v("options")]),t._v(" argument (optional) used to specifies whether to use compression.")]),t._v(" "),n("ul",[n("li",[t._v('Enable compression when storing "blocks" since they compress well.')]),t._v(" "),n("li",[t._v('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')])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" MemoryDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/Memory'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" TransactionDb "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/db/engines/TransactionDb'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" memoryDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MemoryDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" txDb "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TransactionDb")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Declare key/value pair to allocate to store under a the key")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" key "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'some value'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Store key/value pair in memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve value for key from memory db")]),t._v("\nvalueRetrieved "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Delete key/value pair from memory db")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("del")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Transaction to Store key/value pair in transaction db")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isTxSuccess "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transaction")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n txDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("put")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Boolean to indicate whether transaction was successful or not")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transaction successful?: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("isTxSuccess"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve transaction value from memory db")]),t._v("\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Transfered value: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("memoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("get")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("key"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Close the memory database")]),t._v("\nmemoryDb"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("close")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br")])]),n("h1",{attrs:{id:"hierarchy"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),n("p",[n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1),t._v(" "),n("p",[n("strong",[t._v("↳ Memory")])]),t._v(" "),n("h1",{attrs:{id:"implements"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),n("ul",[n("li",[n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),n("h1",{attrs:{id:"constructors"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),n("p",[n("a",{attrs:{id:"constructor"}})]),t._v(" "),n("h2",{attrs:{id:"constructor"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),n("p",[t._v("⊕ "),n("strong",[t._v("new Memory")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("p",[n("em",[t._v("Overrides "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Memory.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Memory.ts:66"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),n("hr"),t._v(" "),n("h1",{attrs:{id:"methods"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),n("p",[n("a",{attrs:{id:"close"}})]),t._v(" "),n("h2",{attrs:{id:"close"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("close")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#close"}},[t._v("close")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:51"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"del"}})]),t._v(" "),n("h2",{attrs:{id:"del"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("del")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#del"}},[t._v("del")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:81"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"drop"}})]),t._v(" "),n("h2",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("drop")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:59"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty"}})]),t._v(" "),n("h2",{attrs:{id:"empty"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("empty")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:63"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"get"}})]),t._v(" "),n("h2",{attrs:{id:"get"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("get")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#get"}},[t._v("get")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:93"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("Uint8Array")]),t._v(" | "),n("code",[t._v("null")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"maintain"}})]),t._v(" "),n("h2",{attrs:{id:"maintain"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("maintain")]),t._v("(fn: "),n("em",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:71"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"open"}})]),t._v(" "),n("h2",{attrs:{id:"open"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("open")]),t._v("(): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#open"}},[t._v("open")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:55"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"put"}})]),t._v(" "),n("h2",{attrs:{id:"put"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("put")]),t._v("(key: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v(", value: "),n("em",[n("code",[t._v("Uint8Array")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#put"}},[t._v("put")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:107"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("key")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])]),t._v(" "),n("tr",[n("td",[t._v("value")]),t._v(" "),n("td",[n("code",[t._v("Uint8Array")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"rename"}})]),t._v(" "),n("h2",{attrs:{id:"rename"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("rename")]),t._v("(base: "),n("em",[n("code",[t._v("string")])]),t._v(", file: "),n("em",[n("code",[t._v("string")])]),t._v("): "),n("code",[t._v("void")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:67"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("base")]),t._v(" "),n("td",[n("code",[t._v("string")])])]),t._v(" "),n("tr",[n("td",[t._v("file")]),t._v(" "),n("td",[n("code",[t._v("string")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("void")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"size"}})]),t._v(" "),n("h2",{attrs:{id:"size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("size")]),t._v("(): "),n("code",[t._v("number")])]),t._v(" "),n("p",[n("em",[t._v("Implementation of "),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")]),t._v("."),n("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#size"}},[t._v("size")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:77"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("number")])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"transaction"}})]),t._v(" "),n("h2",{attrs:{id:"transaction"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("transaction")]),t._v("(fn: "),n("em",[n("code",[t._v("function")])]),t._v("): "),n("code",[t._v("boolean")])]),t._v(" "),n("p",[n("em",[t._v("Inherited from "),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")]),t._v("."),n("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html#transaction"}},[t._v("transaction")])],1)]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("engines/TransactionDb.ts:29"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("fn")]),t._v(" "),n("td",[n("code",[t._v("function")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("boolean")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/240.4390c353.js b/docs/assets/js/240.4390c353.js new file mode 100644 index 000000000..f3eb49826 --- /dev/null +++ b/docs/assets/js/240.4390c353.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{306:function(t,a,e){"use strict";e.r(a);var s=e(46),n=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"u8atohex"}})]),t._v(" "),e("h2",{attrs:{id:"u8atohex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#u8atohex","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToHex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("u8aToHex")]),t._v("(value?: "),e("em",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(", bitLength?: "),e("em",[e("code",[t._v("number")])]),t._v(", isPrefixed?: "),e("em",[e("code",[t._v("boolean")])]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toHex.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toHex.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": u8aToHex")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Creates a hex string from a Uint8Array object.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("UInt8Array")]),t._v(" input values return the actual hex string. "),e("code",[t._v("null")]),t._v(" or "),e("code",[t._v("undefined")]),t._v(" values returns an "),e("code",[t._v("0x")]),t._v(" string.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToHex "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0xf")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0x68656c0f")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Uint8Array")]),t._v(" | "),e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("-")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("-1")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" isPrefixed")]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("true")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/241.d3f5e4de.js b/docs/assets/js/241.d3f5e4de.js new file mode 100644 index 000000000..591d409be --- /dev/null +++ b/docs/assets/js/241.d3f5e4de.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{303:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atostring"}})]),t._v(" "),s("h2",{attrs:{id:"u8atostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atostring","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToString")]),t._v("(value?: "),s("em",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toString.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toString.ts:35"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToString")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a utf-8 string from a Uint8Array object.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("UInt8Array")]),t._v(" input values return the actual decoded utf-8 string. "),s("code",[t._v("null")]),t._v(" or "),s("code",[t._v("undefined")]),t._v(" values returns an empty string.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToString "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6c")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x6f")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hello")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/242.733a2eb7.js b/docs/assets/js/242.733a2eb7.js new file mode 100644 index 000000000..445269cf9 --- /dev/null +++ b/docs/assets/js/242.733a2eb7.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{304:function(t,a,s){"use strict";s.r(a);var n=s(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"u8atou8a"}})]),t._v(" "),s("h2",{attrs:{id:"u8atou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#u8atou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" u8aToU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("u8aToU8a")]),t._v("(value?: "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toU8a.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("u8a/toU8a.ts:27"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": u8aToU8a")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("summary")])]),t._v(": Creates a Uint8Array value from a Uint8Array bignumber or hex input.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": "),s("code",[t._v("null")]),t._v(" inputs returns a "),s("code",[t._v("[]")]),t._v(" result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" u8aToU8a "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x34")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("u8aToU8a")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0x1234")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x12, 0x34])")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("number")]),t._v("> | "),s("code",[t._v("Buffer")]),t._v(" | "),s("code",[t._v("Uint8Array")]),t._v(" | "),s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/25.d80e6990.js b/docs/assets/js/25.d80e6990.js new file mode 100644 index 000000000..1ecb60927 --- /dev/null +++ b/docs/assets/js/25.d80e6990.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{430:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#branch"}},[t._v("BRANCH")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#empty"}},[t._v("EMPTY")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html#leaf"}},[t._v("LEAF")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumeration members")]),t._v(" "),r("p",[r("a",{attrs:{id:"branch"}})]),t._v(" "),r("h2",{attrs:{id:"branch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#branch","aria-hidden":"true"}},[t._v("#")]),t._v(" BRANCH")]),t._v(" "),r("p",[r("strong",[t._v("BRANCH")]),t._v(": = 1")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" EMPTY")]),t._v(" "),r("p",[r("strong",[t._v("EMPTY")]),t._v(": = 0")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:6"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"leaf"}})]),t._v(" "),r("h2",{attrs:{id:"leaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" LEAF")]),t._v(" "),r("p",[r("strong",[t._v("LEAF")]),t._v(": = 2")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("FileFlatDb/types.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/26.bce2e7e5.js b/docs/assets/js/26.bce2e7e5.js new file mode 100644 index 000000000..4afc138d3 --- /dev/null +++ b/docs/assets/js/26.bce2e7e5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{433:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("BaseDb")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[t._v("FileTreeDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/27.fc38d8b0.js b/docs/assets/js/27.fc38d8b0.js new file mode 100644 index 000000000..77d3e3def --- /dev/null +++ b/docs/assets/js/27.fc38d8b0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{436:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ TxDb")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"close"}})]),t._v(" "),r("h2",{attrs:{id:"close"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#close","aria-hidden":"true"}},[t._v("#")]),t._v(" close")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("close")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#close"}},[t._v("close")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"del"}})]),t._v(" "),r("h2",{attrs:{id:"del"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#del","aria-hidden":"true"}},[t._v("#")]),t._v(" del")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("del")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#del"}},[t._v("del")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"drop"}})]),t._v(" "),r("h2",{attrs:{id:"drop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drop","aria-hidden":"true"}},[t._v("#")]),t._v(" drop")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("drop")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#drop"}},[t._v("drop")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"empty"}})]),t._v(" "),r("h2",{attrs:{id:"empty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#empty","aria-hidden":"true"}},[t._v("#")]),t._v(" empty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("empty")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#empty"}},[t._v("empty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maintain"}})]),t._v(" "),r("h2",{attrs:{id:"maintain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maintain","aria-hidden":"true"}},[t._v("#")]),t._v(" maintain")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("maintain")]),t._v("(fn: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#maintain"}},[t._v("maintain")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"open"}})]),t._v(" "),r("h2",{attrs:{id:"open"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#open","aria-hidden":"true"}},[t._v("#")]),t._v(" open")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("open")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#open"}},[t._v("open")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"put"}})]),t._v(" "),r("h2",{attrs:{id:"put"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#put","aria-hidden":"true"}},[t._v("#")]),t._v(" put")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("put")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#put"}},[t._v("put")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rename"}})]),t._v(" "),r("h2",{attrs:{id:"rename"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rename","aria-hidden":"true"}},[t._v("#")]),t._v(" rename")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rename")]),t._v("(base: "),r("em",[r("code",[t._v("string")])]),t._v(", file: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#rename"}},[t._v("rename")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("base")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("file")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("size")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")]),t._v("."),r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html#size"}},[t._v("size")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"transaction"}})]),t._v(" "),r("h2",{attrs:{id:"transaction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transaction","aria-hidden":"true"}},[t._v("#")]),t._v(" transaction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("transaction")]),t._v("(fn: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("fn")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/32.c9b1699b.js b/docs/assets/js/32.c9b1699b.js new file mode 100644 index 000000000..e69e68275 --- /dev/null +++ b/docs/assets/js/32.c9b1699b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{451:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/33.9cd88591.js b/docs/assets/js/33.9cd88591.js new file mode 100644 index 000000000..88f951945 --- /dev/null +++ b/docs/assets/js/33.9cd88591.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{454:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/36.e712ae96.js b/docs/assets/js/36.e712ae96.js new file mode 100644 index 000000000..99aab9503 --- /dev/null +++ b/docs/assets/js/36.e712ae96.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{463:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/37.e2bf13b0.js b/docs/assets/js/37.e2bf13b0.js new file mode 100644 index 000000000..b306268e1 --- /dev/null +++ b/docs/assets/js/37.e2bf13b0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{466:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/39.eeddab89.js b/docs/assets/js/39.eeddab89.js new file mode 100644 index 000000000..0fb8d85b4 --- /dev/null +++ b/docs/assets/js/39.eeddab89.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{472:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"enumerations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumerations")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html"}},[e._v("Slot")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#key"}},[e._v("Key")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#nibblebuffer"}},[e._v("NibbleBuffer")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html#value"}},[e._v("Value")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"key"}})]),e._v(" "),a("h2",{attrs:{id:"key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[e._v("#")]),e._v(" Key")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Key")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:16"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"nibblebuffer"}})]),e._v(" "),a("h2",{attrs:{id:"nibblebuffer"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#nibblebuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" NibbleBuffer")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ NibbleBuffer")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:11"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"value"}})]),e._v(" "),a("h2",{attrs:{id:"value"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" Value")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Value")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("FileFlatDb/types.ts:22"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/41.e1f4f49a.js b/docs/assets/js/41.e1f4f49a.js new file mode 100644 index 000000000..5af04b78f --- /dev/null +++ b/docs/assets/js/41.e1f4f49a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{478:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#basedboptions"}},[t._v("BaseDbOptions")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progresscb"}},[t._v("ProgressCb")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"basedboptions"}})]),t._v(" "),r("h2",{attrs:{id:"basedboptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#basedboptions","aria-hidden":"true"}},[t._v("#")]),t._v(" BaseDbOptions")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ BaseDbOptions")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progresscb"}})]),t._v(" "),r("h2",{attrs:{id:"progresscb"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progresscb","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressCb")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressCb")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(progress: "),r("em",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("progress")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/db/modules/_types_.html#progressvalue"}},[t._v("ProgressValue")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"progressvalue"}})]),t._v(" "),r("h2",{attrs:{id:"progressvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#progressvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" ProgressValue")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ProgressValue")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/42.7f31bca0.js b/docs/assets/js/42.7f31bca0.js new file mode 100644 index 000000000..0270aa912 --- /dev/null +++ b/docs/assets/js/42.7f31bca0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{481:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"create-account"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-account","aria-hidden":"true"}},[t._v("#")]),t._v(" Create Account")]),t._v(" "),a("p",[t._v("The following example shows how to create and account with keyring.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import Keyring class and utility function")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" stringToU8a "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util/string/toU8a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create account seed for Alice")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("' '")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an instance of the Keyring")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Keyring")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create pair and add Alice to keyring pair dictionary (with account seed)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pairAlice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Created keyring pair for Alice with address: `")])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pairAlice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/52.07201cd3.js b/docs/assets/js/52.07201cd3.js new file mode 100644 index 000000000..e9bac836d --- /dev/null +++ b/docs/assets/js/52.07201cd3.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{421:function(s,t,e){"use strict";e.r(t);var i=e(46),a=Object(i.a)({},function(){var s=this.$createElement,t=this._self._c||s;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"sign-verify-message-using-nacl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sign-verify-message-using-nacl","aria-hidden":"true"}},[this._v("#")]),this._v(" Sign & Verify Message using NaCl")]),this._v(" "),t("p",[this._v('The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.')]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/54.36b1fbcd.js b/docs/assets/js/54.36b1fbcd.js new file mode 100644 index 000000000..f84d41f43 --- /dev/null +++ b/docs/assets/js/54.36b1fbcd.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{473:function(e,t,a){"use strict";a.r(t);var n=a(46),s=Object(n.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"util-crypto-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#util-crypto-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Util-Crypto Examples")]),e._v(" "),a("p",[e._v("Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.")]),e._v(" "),a("h2",{attrs:{id:"running-the-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#running-the-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Running the examples")]),e._v(" "),a("p",[e._v("From within each folder run the following to install required dependencies and to execute the example:")]),e._v(" "),a("div",{staticClass:"language-shell line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("yarn;\nyarn start\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br"),a("span",{staticClass:"line-number"},[e._v("2")]),a("br")])])])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/57.541a883c.js b/docs/assets/js/57.541a883c.js new file mode 100644 index 000000000..4e54f5f7d --- /dev/null +++ b/docs/assets/js/57.541a883c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{517:function(r,t,e){"use strict";e.r(t);var a=e(46),s=Object(a.a)({},function(){var r=this,t=r.$createElement,e=r._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("p",[e("strong",[r._v("Pairs")])]),r._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[r._v("#")]),r._v(" Implements")]),r._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[r._v("KeyringPairs")])],1)]),r._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[r._v("#")]),r._v(" Constructors")]),r._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),r._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[r._v("#")]),r._v(" constructor")]),r._v(" "),e("p",[r._v("⊕ "),e("strong",[r._v("new Pairs")]),r._v("(): "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:17"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[r._v("Pairs")])],1),r._v(" "),e("hr"),r._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),r._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[r._v("#")]),r._v(" add")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("add")]),r._v("(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:23"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("pair")]),r._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),r._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[r._v("#")]),r._v(" all")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("all")]),r._v("(): "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:30"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("Array")]),r._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),r._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[r._v("#")]),r._v(" get")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("get")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:34"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),e("hr"),r._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),r._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[r._v("#")]),r._v(" remove")]),r._v(" "),e("p",[r._v("▸ "),e("strong",[r._v("remove")]),r._v("(address: "),e("em",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])]),r._v("): "),e("code",[r._v("void")])]),r._v(" "),e("p",[e("em",[r._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[r._v("pairs.ts:49"),e("OutboundLink")],1)])]),r._v(" "),e("p",[e("strong",[r._v("Parameters:")])]),r._v(" "),e("table",[e("thead",[e("tr",[e("th",[r._v("Name")]),r._v(" "),e("th",[r._v("Type")])])]),r._v(" "),e("tbody",[e("tr",[e("td",[r._v("address")]),r._v(" "),e("td",[e("code",[r._v("string")]),r._v(" | "),e("code",[r._v("Uint8Array")])])])])]),r._v(" "),e("p",[e("strong",[r._v("Returns:")]),r._v(" "),e("code",[r._v("void")])]),r._v(" "),e("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/58.434d2ad0.js b/docs/assets/js/58.434d2ad0.js new file mode 100644 index 000000000..bf34c849a --- /dev/null +++ b/docs/assets/js/58.434d2ad0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{520:function(r,e,t){"use strict";t.r(e);var a=t(46),_=Object(a.a)({},function(){var r=this,e=r.$createElement,t=r._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),t("p",[t("strong",[r._v("KeyringInstance")])]),r._v(" "),t("h1",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),t("p",[t("a",{attrs:{id:"pairs"}})]),r._v(" "),t("h2",{attrs:{id:"pairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pairs","aria-hidden":"true"}},[r._v("#")]),r._v(" pairs")]),r._v(" "),t("p",[t("strong",[r._v("● pairs")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:58"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"publickeys"}})]),r._v(" "),t("h2",{attrs:{id:"publickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" publicKeys")]),r._v(" "),t("p",[t("strong",[r._v("● publicKeys")]),r._v(": "),t("em",[t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:59"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"type"}})]),r._v(" "),t("h2",{attrs:{id:"type"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[r._v("#")]),r._v(" type")]),r._v(" "),t("p",[t("strong",[r._v("● type")]),r._v(": "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:60"),t("OutboundLink")],1)])]),r._v(" "),t("hr"),r._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[r._v("#")]),r._v(" Methods")]),r._v(" "),t("p",[t("a",{attrs:{id:"addfromaddress"}})]),r._v(" "),t("h2",{attrs:{id:"addfromaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromAddress")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", encoded?: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])]),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:67"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" encoded")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("null")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromjson"}})]),r._v(" "),t("h2",{attrs:{id:"addfromjson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromjson","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromJson")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:70"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfrommnemonic"}})]),r._v(" "),t("h2",{attrs:{id:"addfrommnemonic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfrommnemonic","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromMnemonic")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromMnemonic")]),r._v("(mnemonic: "),t("em",[t("code",[r._v("string")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:68"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("mnemonic")]),r._v(" "),t("td",[t("code",[r._v("string")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addfromseed"}})]),r._v(" "),t("h2",{attrs:{id:"addfromseed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addfromseed","aria-hidden":"true"}},[r._v("#")]),r._v(" addFromSeed")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addFromSeed")]),r._v("(seed: "),t("em",[t("code",[r._v("Uint8Array")])]),r._v(", meta?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1),r._v(", type?: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:69"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("seed")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" meta")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[r._v("KeyringPair$Meta")])],1)]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" type")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[r._v("KeyringPairType")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"addpair"}})]),r._v(" "),t("h2",{attrs:{id:"addpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addpair","aria-hidden":"true"}},[r._v("#")]),r._v(" addPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("addPair")]),r._v("(pair: "),t("em",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:66"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("pair")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"decodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"decodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" decodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("decodeAddress")]),r._v("(encoded: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:62"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("encoded")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Uint8Array")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"encodeaddress"}})]),r._v(" "),t("h2",{attrs:{id:"encodeaddress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[r._v("#")]),r._v(" encodeAddress")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("encodeAddress")]),r._v("(key: "),t("em",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("code",[r._v("string")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:63"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("key")]),r._v(" "),t("td",[t("code",[r._v("Uint8Array")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("string")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpair"}})]),r._v(" "),t("h2",{attrs:{id:"getpair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[r._v("#")]),r._v(" getPair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:71"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")])],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpairs"}})]),r._v(" "),t("h2",{attrs:{id:"getpairs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[r._v("#")]),r._v(" getPairs")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPairs")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:72"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[r._v("KeyringPair")]),r._v(">")],1),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"getpublickeys"}})]),r._v(" "),t("h2",{attrs:{id:"getpublickeys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getpublickeys","aria-hidden":"true"}},[r._v("#")]),r._v(" getPublicKeys")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("getPublicKeys")]),r._v("(): "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:73"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("Array")]),r._v("<"),t("code",[r._v("Uint8Array")]),r._v(">")]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"removepair"}})]),r._v(" "),t("h2",{attrs:{id:"removepair"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removepair","aria-hidden":"true"}},[r._v("#")]),r._v(" removePair")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("removePair")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:74"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"setaddressprefix"}})]),r._v(" "),t("h2",{attrs:{id:"setaddressprefix"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setaddressprefix","aria-hidden":"true"}},[r._v("#")]),r._v(" setAddressPrefix")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("setAddressPrefix")]),r._v("(prefix: "),t("em",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1),r._v("): "),t("code",[r._v("void")])]),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:64"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("prefix")]),r._v(" "),t("td",[t("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[r._v("Prefix")])],1)])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("code",[r._v("void")])]),r._v(" "),t("hr"),r._v(" "),t("p",[t("a",{attrs:{id:"tojson"}})]),r._v(" "),t("h2",{attrs:{id:"tojson"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[r._v("#")]),r._v(" toJson")]),r._v(" "),t("p",[r._v("▸ "),t("strong",[r._v("toJson")]),r._v("(address: "),t("em",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])]),r._v(", passphrase?: "),t("em",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])]),r._v("): "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("p",[t("em",[r._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[r._v("types.ts:75"),t("OutboundLink")],1)])]),r._v(" "),t("p",[t("strong",[r._v("Parameters:")])]),r._v(" "),t("table",[t("thead",[t("tr",[t("th",[r._v("Name")]),r._v(" "),t("th",[r._v("Type")])])]),r._v(" "),t("tbody",[t("tr",[t("td",[r._v("address")]),r._v(" "),t("td",[t("code",[r._v("string")]),r._v(" | "),t("code",[r._v("Uint8Array")])])]),r._v(" "),t("tr",[t("td",[t("code",[r._v("Optional")]),r._v(" passphrase")]),r._v(" "),t("td",[t("code",[r._v("undefined")]),r._v(" | "),t("code",[r._v("string")])])])])]),r._v(" "),t("p",[t("strong",[r._v("Returns:")]),r._v(" "),t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[r._v("KeyringPair$Json")])],1),r._v(" "),t("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/59.dc6dac5c.js b/docs/assets/js/59.dc6dac5c.js new file mode 100644 index 000000000..44076cec8 --- /dev/null +++ b/docs/assets/js/59.dc6dac5c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{523:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("KeyringPair")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"address"}})]),t._v(" "),r("h2",{attrs:{id:"address"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#address","aria-hidden":"true"}},[t._v("#")]),t._v(" address")]),t._v(" "),r("p",[r("strong",[t._v("● address")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"decodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" decodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● decodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(", encoded?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodepkcs8"}})]),t._v(" "),r("h2",{attrs:{id:"encodepkcs8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodepkcs8","aria-hidden":"true"}},[t._v("#")]),t._v(" encodePkcs8")]),t._v(" "),r("p",[r("strong",[t._v("● encodePkcs8")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getmeta"}})]),t._v(" "),r("h2",{attrs:{id:"getmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),r("p",[r("strong",[t._v("● getMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"islocked"}})]),t._v(" "),r("h2",{attrs:{id:"islocked"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#islocked","aria-hidden":"true"}},[t._v("#")]),t._v(" isLocked")]),t._v(" "),r("p",[r("strong",[t._v("● isLocked")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"lock"}})]),t._v(" "),r("h2",{attrs:{id:"lock"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lock","aria-hidden":"true"}},[t._v("#")]),t._v(" lock")]),t._v(" "),r("p",[r("strong",[t._v("● lock")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"publickey"}})]),t._v(" "),r("h2",{attrs:{id:"publickey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#publickey","aria-hidden":"true"}},[t._v("#")]),t._v(" publicKey")]),t._v(" "),r("p",[r("strong",[t._v("● publicKey")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"setmeta"}})]),t._v(" "),r("h2",{attrs:{id:"setmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setmeta","aria-hidden":"true"}},[t._v("#")]),t._v(" setMeta")]),t._v(" "),r("p",[r("strong",[t._v("● setMeta")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(meta: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[t._v("KeyringPair$Meta")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("● type")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(passphrase?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" passphrase")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"totype"}})]),t._v(" "),r("h2",{attrs:{id:"totype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#totype","aria-hidden":"true"}},[t._v("#")]),t._v(" toType")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toType")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v("): "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"verify"}})]),t._v(" "),r("h2",{attrs:{id:"verify"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#verify","aria-hidden":"true"}},[t._v("#")]),t._v(" verify")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("verify")]),t._v("(message: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("message")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/60.e830d4c9.js b/docs/assets/js/60.e830d4c9.js new file mode 100644 index 000000000..38f59f0d3 --- /dev/null +++ b/docs/assets/js/60.e830d4c9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{526:function(t,r,e){"use strict";e.r(r);var a=e(46),i=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("KeyringPairs")])]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)]),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"add"}})]),t._v(" "),e("h2",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[e("strong",[t._v("● add")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:51"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(pair: "),e("em",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("pair")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"all"}})]),t._v(" "),e("h2",{attrs:{id:"all"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all","aria-hidden":"true"}},[t._v("#")]),t._v(" all")]),t._v(" "),e("p",[e("strong",[t._v("● all")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:52"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(): "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Array")]),t._v("<"),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"get"}})]),t._v(" "),e("h2",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),e("p",[e("strong",[t._v("● get")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:53"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"remove"}})]),t._v(" "),e("h2",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove","aria-hidden":"true"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[e("strong",[t._v("● remove")]),t._v(": "),e("em",[e("code",[t._v("function")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:54"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸(address: "),e("em",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("address")]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("Uint8Array")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/61.a5c6d657.js b/docs/assets/js/61.a5c6d657.js new file mode 100644 index 000000000..08e6edaf2 --- /dev/null +++ b/docs/assets/js/61.a5c6d657.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{529:function(e,t,r){"use strict";r.r(t);var d=r(46),_=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(encoded: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/decode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/decode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("encoded")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/63.44b784a4.js b/docs/assets/js/63.44b784a4.js new file mode 100644 index 000000000..49d2e1e24 --- /dev/null +++ b/docs/assets/js/63.44b784a4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{535:function(e,t,r){"use strict";r.r(t);var _=r(46),s=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(_key: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", prefix?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/encode.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/encode.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_key")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" prefix")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[e._v("Prefix")])],1),e._v(" "),r("td",[e._v("defaults.prefix")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/64.0b302571.js b/docs/assets/js/64.0b302571.js new file mode 100644 index 000000000..e9d3ac647 --- /dev/null +++ b/docs/assets/js/64.0b302571.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{538:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"setprefix"}})]),t._v(" "),r("h2",{attrs:{id:"setprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" setPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("setPrefix")]),t._v("(prefix: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/setPrefix.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("address/setPrefix.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("prefix")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_address_types_.html#prefix"}},[t._v("Prefix")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/65.c59be25f.js b/docs/assets/js/65.c59be25f.js new file mode 100644 index 000000000..fb05a1074 --- /dev/null +++ b/docs/assets/js/65.c59be25f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{537:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),e._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[e._v("#")]),e._v(" Prefix")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ Prefix")]),e._v(": "),r("em",[r("code",[e._v("0")]),e._v(" | "),r("code",[e._v("1")]),e._v(" | "),r("code",[e._v("3")]),e._v(" | "),r("code",[e._v("42")]),e._v(" | "),r("code",[e._v("43")]),e._v(" | "),r("code",[e._v("68")]),e._v(" | "),r("code",[e._v("69")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("address/types.ts:5"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/66.d89c854d.js b/docs/assets/js/66.d89c854d.js new file mode 100644 index 000000000..71f538c0d --- /dev/null +++ b/docs/assets/js/66.d89c854d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{536:function(e,t,r){"use strict";r.r(t);var d=r(46),n=Object(d.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", _encrypted?: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])]),e._v("): "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/decode.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/decode.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _encrypted")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("DecodeResult")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/68.cc747b6b.js b/docs/assets/js/68.cc747b6b.js new file mode 100644 index 000000000..bf6004fc9 --- /dev/null +++ b/docs/assets/js/68.cc747b6b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{533:function(e,t,r){"use strict";r.r(t);var n=r(46),a=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(__namedParameters: "),r("em",[r("code",[e._v("object")])]),e._v(", passphrase?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/encode.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("pair/encode.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[r("code",[e._v("object")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" passphrase")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/69.a0aca143.js b/docs/assets/js/69.a0aca143.js new file mode 100644 index 000000000..ed16899fe --- /dev/null +++ b/docs/assets/js/69.a0aca143.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{531:function(t,r,e){"use strict";e.r(r);var n=e(46),a=Object(n.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"everybody"}})]),t._v(" "),e("h2",{attrs:{id:"everybody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#everybody","aria-hidden":"true"}},[t._v("#")]),t._v(" everybody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("everybody")]),t._v("(): "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/nobody.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/nobody.ts:25"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/70.6aa525bb.js b/docs/assets/js/70.6aa525bb.js new file mode 100644 index 000000000..b01865e02 --- /dev/null +++ b/docs/assets/js/70.6aa525bb.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{530:function(t,e,r){"use strict";r.r(e);var n=r(46),o=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJson")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJson")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1),t._v(", __namedParameters: "),r("em",[r("code",[t._v("object")])]),t._v(", encoded: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", isEncrypted: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/toJson.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/toJson.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[t._v("KeyringPairType")])],1)]),t._v(" "),r("tr",[r("td",[t._v("__namedParameters")]),t._v(" "),r("td",[r("code",[t._v("object")])])]),t._v(" "),r("tr",[r("td",[t._v("encoded")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("isEncrypted")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[t._v("KeyringPair$Json")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/71.83d894e0.js b/docs/assets/js/71.83d894e0.js new file mode 100644 index 000000000..aa64ee164 --- /dev/null +++ b/docs/assets/js/71.83d894e0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{528:function(t,a,e){"use strict";e.r(a);var r=e(46),s=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("p",[e("a",{attrs:{id:"pairinfo"}})]),t._v(" "),e("h2",{attrs:{id:"pairinfo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pairinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" PairInfo")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ PairInfo")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("pair/types.ts:5"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/73.89cc551f.js b/docs/assets/js/73.89cc551f.js new file mode 100644 index 000000000..2b0ca8212 --- /dev/null +++ b/docs/assets/js/73.89cc551f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{525:function(t,e,n){"use strict";n.r(e);var r=n(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"testkeyring"}})]),t._v(" "),n("h2",{attrs:{id:"testkeyring"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#testkeyring","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyring")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("testKeyring")]),t._v("(options?: "),n("em",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testing.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("testing.ts:41"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("name")])]),t._v(": testKeyring")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("summary")])]),t._v(": Create an instance of Keyring pre-populated with locked test accounts")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": 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.")]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[n("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),n("td",[n("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/74.0d118f78.js b/docs/assets/js/74.0d118f78.js new file mode 100644 index 000000000..3569cbca2 --- /dev/null +++ b/docs/assets/js/74.0d118f78.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{524:function(t,e,r){"use strict";r.r(e);var s=r(46),n=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"testkeyringpairs"}})]),t._v(" "),r("h2",{attrs:{id:"testkeyringpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#testkeyringpairs","aria-hidden":"true"}},[t._v("#")]),t._v(" testKeyringPairs")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("testKeyringPairs")]),t._v("(options?: "),r("em",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v("): "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testingPairs.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("testingPairs.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("TestKeyringMap")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/75.11553212.js b/docs/assets/js/75.11553212.js new file mode 100644 index 000000000..296c4c983 --- /dev/null +++ b/docs/assets/js/75.11553212.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{522:function(e,r,t){"use strict";t.r(r);var a=t(46),i=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[e._v("KeyringInstance")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[e._v("KeyringPair")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[e._v("KeyringPairs")])],1)]),e._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_json"}},[e._v("KeyringPair$Json")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonencoding"}},[e._v("KeyringPair$JsonEncoding")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_jsonversion"}},[e._v("KeyringPair$JsonVersion")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpair_meta"}},[e._v("KeyringPair$Meta")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/keyring/modules/_types_.html#keyringpairtype"}},[e._v("KeyringPairType")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"keyringoptions"}})]),e._v(" "),t("h2",{attrs:{id:"keyringoptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringoptions","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringOptions")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringOptions")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:9"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_json"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-json"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-json","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Json")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Json")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:26"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonencoding"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonencoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonencoding","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonEncoding")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonEncoding")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:20"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_jsonversion"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-jsonversion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-jsonversion","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$JsonVersion")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$JsonVersion")]),e._v(": "),t("em",[e._v('"0" | "1"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpair_meta"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpair-meta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpair-meta","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPair$Meta")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPair$Meta")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"keyringpairtype"}})]),e._v(" "),t("h2",{attrs:{id:"keyringpairtype"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#keyringpairtype","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringPairType")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ KeyringPairType")]),e._v(": "),t("em",[e._v('"ed25519" | "sr25519"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:7"),t("OutboundLink")],1)])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/79.71ce2c6c.js b/docs/assets/js/79.71ce2c6c.js new file mode 100644 index 000000000..d192e93eb --- /dev/null +++ b/docs/assets/js/79.71ce2c6c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{516:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ExtensionHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ExtensionHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/80.c2f44ca3.js b/docs/assets/js/80.c2f44ca3.js new file mode 100644 index 000000000..8421a30e5 --- /dev/null +++ b/docs/assets/js/80.c2f44ca3.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[80],{515:function(e,r,t){"use strict";t.r(r);var a=t(46),o=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("p",[t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),t("p",[t("strong",[e._v("↳ LeafHeader")])]),e._v(" "),t("h1",{attrs:{id:"constructors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),t("p",[t("a",{attrs:{id:"constructor"}})]),e._v(" "),t("h2",{attrs:{id:"constructor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),t("p",[e._v("⊕ "),t("strong",[e._v("new LeafHeader")]),e._v("(input: "),t("em",[t("code",[e._v("number")])]),e._v("): "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("input")]),e._v(" "),t("td",[t("code",[e._v("number")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),t("p",[t("a",{attrs:{id:"tonumber"}})]),e._v(" "),t("h2",{attrs:{id:"tonumber"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("toNumber")]),e._v("(): "),t("code",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Inherited from "),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")]),e._v("."),t("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("number")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/81.8a7a630b.js b/docs/assets/js/81.8a7a630b.js new file mode 100644 index 000000000..e0dfe2f09 --- /dev/null +++ b/docs/assets/js/81.8a7a630b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[81],{513:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NibbleHeader")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NibbleHeader")]),e._v("(input: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/82.63a91c1f.js b/docs/assets/js/82.63a91c1f.js new file mode 100644 index 000000000..24299916b --- /dev/null +++ b/docs/assets/js/82.63a91c1f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{512:function(e,t,r){"use strict";r.r(t);var a=r(46),o=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("NodeHeader")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NodeHeader")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:92"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"nodetype"}})]),e._v(" "),r("h2",{attrs:{id:"nodetype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nodetype","aria-hidden":"true"}},[e._v("#")]),e._v(" nodeType")]),e._v(" "),r("p",[r("strong",[e._v("get nodeType")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L118",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:118"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")]),e._v(" | "),r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("NodeHeader.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/83.ce3a21bb.js b/docs/assets/js/83.ce3a21bb.js new file mode 100644 index 000000000..881e37e37 --- /dev/null +++ b/docs/assets/js/83.ce3a21bb.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{509:function(t,r,s){"use strict";s.r(r);var e=s(46),a=Object(e.a)({},function(){var t=this.$createElement,r=this._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[this._v("#")]),this._v(" Hierarchy")]),this._v(" "),r("p",[r("strong",[this._v("Null")])])])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/84.30cc8514.js b/docs/assets/js/84.30cc8514.js new file mode 100644 index 000000000..97a4c75c6 --- /dev/null +++ b/docs/assets/js/84.30cc8514.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{510:function(t,e,n){"use strict";n.r(e);var o=n(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"variables"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_no_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-no-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-no-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_NO_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_NO_VALUE")]),t._v(": "),n("em",[n("code",[t._v("254")])]),t._v(" = 254")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:10"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"branch_node_with_value"}})]),t._v(" "),n("h2",{attrs:{id:"const-branch-node-with-value"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-branch-node-with-value","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" BRANCH_NODE_WITH_VALUE")]),t._v(" "),n("p",[n("strong",[t._v("● BRANCH_NODE_WITH_VALUE")]),t._v(": "),n("em",[n("code",[t._v("255")])]),t._v(" = 255")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:11"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"empty_trie"}})]),t._v(" "),n("h2",{attrs:{id:"const-empty-trie"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-empty-trie","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EMPTY_TRIE")]),t._v(" "),n("p",[n("strong",[t._v("● EMPTY_TRIE")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:5"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("253")])]),t._v(" = 253")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:9"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("128")])]),t._v(" = 128")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:8"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:15"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"extension_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-extension-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-extension-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" EXTENSION_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● EXTENSION_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_big"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-big"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-big","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_BIG")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_BIG")]),t._v(": "),n("em",[n("code",[t._v("127")])]),t._v(" = 127")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:7"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_offset"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-offset"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-offset","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_OFFSET")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:6"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_small_max"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-small-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-small-max","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_SMALL_MAX")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_SMALL_MAX")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:14"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"leaf_node_threshold"}})]),t._v(" "),n("h2",{attrs:{id:"const-leaf-node-threshold"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-leaf-node-threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" LEAF_NODE_THRESHOLD")]),t._v(" "),n("p",[n("strong",[t._v("● LEAF_NODE_THRESHOLD")]),t._v(": "),n("em",[n("code",[t._v("number")])]),t._v(" = LEAF_NODE_BIG - LEAF_NODE_OFFSET")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:12"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_branch"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-branch"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-branch","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_BRANCH")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_BRANCH")]),t._v(": "),n("em",[n("code",[t._v("1")])]),t._v(" = 1")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:17"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_ext"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-ext"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-ext","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_EXT")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_EXT")]),t._v(": "),n("em",[n("code",[t._v("2")])]),t._v(" = 2")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:18"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_leaf"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-leaf"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-leaf","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_LEAF")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_LEAF")]),t._v(": "),n("em",[n("code",[t._v("3")])]),t._v(" = 3")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:19"),n("OutboundLink")],1)])]),t._v(" "),n("hr"),t._v(" "),n("p",[n("a",{attrs:{id:"node_type_null"}})]),t._v(" "),n("h2",{attrs:{id:"const-node-type-null"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#const-node-type-null","aria-hidden":"true"}},[t._v("#")]),t._v(" "),n("code",[t._v("")]),t._v(" NODE_TYPE_NULL")]),t._v(" "),n("p",[n("strong",[t._v("● NODE_TYPE_NULL")]),t._v(": "),n("em",[n("code",[t._v("0")])]),t._v(" = 0")]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("constants.ts:16"),n("OutboundLink")],1)])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/85.d1539fa0.js b/docs/assets/js/85.d1539fa0.js new file mode 100644 index 000000000..4cde3a64b --- /dev/null +++ b/docs/assets/js/85.d1539fa0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{507:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"decode"}})]),e._v(" "),r("h2",{attrs:{id:"decode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decode","aria-hidden":"true"}},[e._v("#")]),e._v(" decode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decode")]),e._v("(input: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/decode.ts#L95",target:"_blank",rel:"noopener noreferrer"}},[e._v("decode.ts:95"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">>")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/86.bf1809e4.js b/docs/assets/js/86.bf1809e4.js new file mode 100644 index 000000000..641b8aa35 --- /dev/null +++ b/docs/assets/js/86.bf1809e4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[86],{506:function(e,t,r){"use strict";r.r(t);var n=r(46),o=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encode","aria-hidden":"true"}},[e._v("#")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(input?: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/encode.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("encode.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" input")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/88.de0b3335.js b/docs/assets/js/88.de0b3335.js new file mode 100644 index 000000000..b06a9c58b --- /dev/null +++ b/docs/assets/js/88.de0b3335.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[88],{503:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"addnibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"addnibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addnibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" addNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("addNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:31"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"decodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeNibbles")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodenibbles"}})]),e._v(" "),r("h2",{attrs:{id:"encodenibbles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeNibbles")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeNibbles")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:65"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractkey"}})]),e._v(" "),r("h2",{attrs:{id:"extractkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractkey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractKey")]),e._v("(key: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"extractnodekey"}})]),e._v(" "),r("h2",{attrs:{id:"extractnodekey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extractnodekey","aria-hidden":"true"}},[e._v("#")]),e._v(" extractNodeKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("extractNodeKey")]),e._v("(__namedParameters: "),r("em",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("__namedParameters")]),e._v(" "),r("td",[e._v("["),r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v("]")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnibblesterminated"}})]),e._v(" "),r("h2",{attrs:{id:"isnibblesterminated"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnibblesterminated","aria-hidden":"true"}},[e._v("#")]),e._v(" isNibblesTerminated")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isNibblesTerminated")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"removenibblesterminator"}})]),e._v(" "),r("h2",{attrs:{id:"removenibblesterminator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#removenibblesterminator","aria-hidden":"true"}},[e._v("#")]),e._v(" removeNibblesTerminator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("removeNibblesTerminator")]),e._v("(nibbles: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("nibbles.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("nibbles")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/90.fc751a64.js b/docs/assets/js/90.fc751a64.js new file mode 100644 index 000000000..021be2364 --- /dev/null +++ b/docs/assets/js/90.fc751a64.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{500:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createbranch"}})]),t._v(" "),r("h2",{attrs:{id:"createbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" createBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v(", hasChildren: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createBranch.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createBranch.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])]),t._v(" "),r("tr",[r("td",[t._v("hasChildren")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("boolean")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/91.9a0c0b54.js b/docs/assets/js/91.9a0c0b54.js new file mode 100644 index 000000000..02297661e --- /dev/null +++ b/docs/assets/js/91.9a0c0b54.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[91],{498:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createempty"}})]),t._v(" "),r("h2",{attrs:{id:"createempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createempty","aria-hidden":"true"}},[t._v("#")]),t._v(" createEmpty")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createEmpty")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createEmpty.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createEmpty.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/92.f45b658c.js b/docs/assets/js/92.f45b658c.js new file mode 100644 index 000000000..0d25e574f --- /dev/null +++ b/docs/assets/js/92.f45b658c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[92],{497:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createextension"}})]),t._v(" "),r("h2",{attrs:{id:"createextension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createextension","aria-hidden":"true"}},[t._v("#")]),t._v(" createExtension")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createExtension")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createExtension.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createExtension.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/93.4228fc8d.js b/docs/assets/js/93.4228fc8d.js new file mode 100644 index 000000000..431bac1d2 --- /dev/null +++ b/docs/assets/js/93.4228fc8d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[93],{495:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createleaf"}})]),t._v(" "),r("h2",{attrs:{id:"createleaf"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createleaf","aria-hidden":"true"}},[t._v("#")]),t._v(" createLeaf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createLeaf")]),t._v("(key: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createLeaf.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createLeaf.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/94.6d5a907e.js b/docs/assets/js/94.6d5a907e.js new file mode 100644 index 000000000..1f1cdb3fd --- /dev/null +++ b/docs/assets/js/94.6d5a907e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[94],{494:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createsubstream"}})]),t._v(" "),r("h2",{attrs:{id:"createsubstream"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createsubstream","aria-hidden":"true"}},[t._v("#")]),t._v(" createSubstream")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createSubstream")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createSubstream.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/createSubstream.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/95.8c661080.js b/docs/assets/js/95.8c661080.js new file mode 100644 index 000000000..65359b19f --- /dev/null +++ b/docs/assets/js/95.8c661080.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[95],{492:function(e,t,r){"use strict";r.r(t);var a=r(46),n=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"createvalue"}})]),e._v(" "),r("h2",{attrs:{id:"createvalue"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createvalue","aria-hidden":"true"}},[e._v("#")]),e._v(" createValue")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createValue")]),e._v("(value: "),r("em",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createValue.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("stream/createValue.ts:9"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("null")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/96.be58a66c.js b/docs/assets/js/96.be58a66c.js new file mode 100644 index 000000000..6ae63de34 --- /dev/null +++ b/docs/assets/js/96.be58a66c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[96],{491:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"encbranch"}})]),t._v(" "),r("h2",{attrs:{id:"encbranch"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encbranch","aria-hidden":"true"}},[t._v("#")]),t._v(" encBranch")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("encBranch")]),t._v("(value: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/endBranch.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("stream/endBranch.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/97.7606a016.js b/docs/assets/js/97.7606a016.js new file mode 100644 index 000000000..b147d6b0e --- /dev/null +++ b/docs/assets/js/97.7606a016.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{489:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"codec"}})]),e._v(" "),a("h2",{attrs:{id:"codec"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codec","aria-hidden":"true"}},[e._v("#")]),e._v(" Codec")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Codec")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/98.a559845e.js b/docs/assets/js/98.a559845e.js new file mode 100644 index 000000000..7e7bde2df --- /dev/null +++ b/docs/assets/js/98.a559845e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{488:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"fromnibbles"}})]),t._v(" "),a("h2",{attrs:{id:"fromnibbles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fromnibbles","aria-hidden":"true"}},[t._v("#")]),t._v(" fromNibbles")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("fromNibbles")]),t._v("(input: "),a("em",[a("code",[t._v("Uint8Array")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fromNibbles.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/fromNibbles.ts:19"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": fromNibbles")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Converts the input to Nibbles.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": From an "),a("code",[t._v("Uint8Array")]),t._v(" input, calculate and return a list of nibbles that makes up the input.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" fromNibbles "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/trie-codec/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("fromNibbles")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Uint8Array")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => Uint8Array([0x41, 0x20]")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("input")]),t._v(" "),a("td",[a("code",[t._v("Uint8Array")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/99.c6bdd4ab.js b/docs/assets/js/99.c6bdd4ab.js new file mode 100644 index 000000000..61242c947 --- /dev/null +++ b/docs/assets/js/99.c6bdd4ab.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{486:function(e,t,s){"use strict";s.r(t);var r=s(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),s("p",[s("a",{attrs:{id:"fusenibbles"}})]),e._v(" "),s("h2",{attrs:{id:"fusenibbles"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#fusenibbles","aria-hidden":"true"}},[e._v("#")]),e._v(" fuseNibbles")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("fuseNibbles")]),e._v("(nibbles: "),s("em",[s("code",[e._v("Uint8Array")])]),e._v(", isLeaf: "),s("em",[s("code",[e._v("boolean")])]),e._v("): "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fuseNibbles.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/fuseNibbles.ts:12"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[e._v("nibbles")]),e._v(" "),s("td",[s("code",[e._v("Uint8Array")])])]),e._v(" "),s("tr",[s("td",[e._v("isLeaf")]),e._v(" "),s("td",[s("code",[e._v("boolean")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/app.1af07c41.js b/docs/assets/js/app.1af07c41.js new file mode 100644 index 000000000..28676bd94 --- /dev/null +++ b/docs/assets/js/app.1af07c41.js @@ -0,0 +1,8 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(e){function t(t){for(var r,i,l=t[0],s=t[1],u=t[2],d=0,f=[];d0?o(r(e),9007199254740991):0}},function(e,t){var n=e.exports={version:"2.6.5"};"number"==typeof __e&&(__e=n)},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(67);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){var r=n(11),o=n(136),a=n(137),i=Object.defineProperty;t.f=n(21)?Object.defineProperty:function(e,t,n){if(r(e),t=a(t,!0),r(n),o)try{return i(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported!");return"value"in n&&(e[t]=n.value),e}},function(e,t,n){var r=n(5),o=n(17),a=n(48),i=n(71)("src"),l=n(150),s=(""+l).split("toString");n(23).inspectSource=function(e){return l.call(e)},(e.exports=function(e,t,n,l){var u="function"==typeof n;u&&(a(n,"name")||o(n,"name",t)),e[t]!==n&&(u&&(a(n,i)||o(n,i,e[t]?""+e[t]:s.join(String(t)))),e===r?e[t]=n:l?e[t]?e[t]=n:o(e,t,n):(delete e[t],o(e,t,n)))})(Function.prototype,"toString",function(){return"function"==typeof this&&this[i]||l.call(this)})},function(e,t,n){var r=n(33);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,n){var r=n(28);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,n){var r=n(108),o=n(83);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t){e.exports=!0},function(e,t,n){"use strict";var r=n(195)(!0);n(88)(String,"String",function(e){this._t=String(e),this._i=0},function(){var e,t=this._t,n=this._i;return n>=t.length?{value:void 0,done:!0}:(e=r(t,n),this._i+=e.length,{value:e,done:!1})})},function(e,t,n){var r=n(7).f,o=n(18),a=n(4)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,a)&&r(e,a,{configurable:!0,value:t})}},function(e,t,n){var r=n(12),o=n(115),a=n(116),i=n(9),l=n(51),s=n(117),u={},c={};(t=e.exports=function(e,t,n,d,f){var h,p,m,v,_=f?function(){return e}:s(e),y=r(n,d,t?2:1),b=0;if("function"!=typeof _)throw TypeError(e+" is not iterable!");if(a(_)){for(h=l(e.length);h>b;b++)if((v=t?y(i(p=e[b])[0],p[1]):y(e[b]))===u||v===c)return v}else for(m=_.call(e);!(p=m.next()).done;)if((v=o(m,y,p.value,t))===u||v===c)return v}).BREAK=u,t.RETURN=c},function(e,t,n){e.exports=n(185)},function(e,t,n){e.exports=n(189)},function(e,t,n){e.exports=n(213)},function(e,t,n){"use strict";function r(e,t,n,r,o,a,i,l){var s,u="function"==typeof e?e.options:e;if(t&&(u.render=t,u.staticRenderFns=n,u._compiled=!0),r&&(u.functional=!0),a&&(u._scopeId="data-v-"+a),i?(s=function(e){(e=e||this.$vnode&&this.$vnode.ssrContext||this.parent&&this.parent.$vnode&&this.parent.$vnode.ssrContext)||"undefined"==typeof __VUE_SSR_CONTEXT__||(e=__VUE_SSR_CONTEXT__),o&&o.call(this,e),e&&e._registeredComponents&&e._registeredComponents.add(i)},u._ssrRegister=s):o&&(s=l?function(){o.call(this,this.$root.$options.shadowRoot)}:o),s)if(u.functional){u._injectStyles=s;var c=u.render;u.render=function(e,t){return s.call(t),c(e,t)}}else{var d=u.beforeCreate;u.beforeCreate=d?[].concat(d,s):[s]}return{exports:e,options:u}}n.d(t,"a",function(){return r})},function(e,t,n){"use strict";var r=n(27);e.exports=function(e,t){return!!e&&r(function(){t?e.call(null,function(){},1):e.call(null)})}},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t,n){var r=n(24);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){var r=n(80),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,n){for(var r=n(100),o=n(73),a=n(30),i=n(5),l=n(17),s=n(32),u=n(2),c=u("iterator"),d=u("toStringTag"),f=s.Array,h={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},p=o(h),m=0;mdocument.F=Object<\/script>"),e.close(),s=e.F;r--;)delete s.prototype[a[r]];return s()};e.exports=Object.create||function(e,t){var n;return null!==e?(l.prototype=r(e),n=new l,l.prototype=null,n[i]=e):n=s(),void 0===t?n:o(n,t)}},function(e,t,n){n(198);for(var r=n(3),o=n(14),a=n(26),i=n(4)("toStringTag"),l="CSSRuleList,CSSStyleDeclaration,CSSValueList,ClientRectList,DOMRectList,DOMStringList,DOMTokenList,DataTransferItemList,FileList,HTMLAllCollection,HTMLCollection,HTMLFormElement,HTMLSelectElement,MediaList,MimeTypeArray,NamedNodeMap,NodeList,PaintRequestList,Plugin,PluginArray,SVGLengthList,SVGNumberList,SVGPathSegList,SVGPointList,SVGStringList,SVGTransformList,SourceBufferList,StyleSheetList,TextTrackCueList,TextTrackList,TouchList".split(","),s=0;s
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var s=n.render(!t),u=s.querySelector(r.barSelector),c=r.speed,d=r.easing;return s.offsetWidth,i(function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(u,function(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}(e,c,d)),1===e?(l(s,{transition:"none",opacity:1}),s.offsetWidth,setTimeout(function(){l(s,{transition:"all "+c+"ms linear",opacity:0}),setTimeout(function(){n.remove(),t()},c)},c)):setTimeout(t,c)}),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout(function(){n.status&&(n.trickle(),e())},r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always(function(){0==--t?(e=0,n.done()):n.set((e-t)/e)}),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){c(document.documentElement,"nprogress-busy"),c(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var i=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,function(e,t){return t.toUpperCase()}),t[n]||(t[n]=function(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}(n))}function r(e,t,r){t=n(t),e.style[t]=r}return function(e,t){var n,o,a=arguments;if(2==a.length)for(n in t)void 0!==(o=t[n])&&t.hasOwnProperty(n)&&r(e,n,o);else r(e,a[1],a[2])}}();function s(e,t){var n="string"==typeof e?e:d(e);return n.indexOf(" "+t+" ")>=0}function u(e,t){var n=d(e),r=n+t;s(n,t)||(e.className=r.substring(1))}function c(e,t){var n,r=d(e);s(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function d(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n})?r.call(t,n,t,e):r)||(e.exports=o)},function(e,t,n){"use strict";var r=n(8),o=n(66)(1);r(r.P+r.F*!n(47)([].map,!0),"Array",{map:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(49),o=n(28);e.exports=function(e){return r(o(e))}},function(e,t,n){var r=n(31),o=n(49),a=n(34),i=n(22),l=n(172);e.exports=function(e,t){var n=1==e,s=2==e,u=3==e,c=4==e,d=6==e,f=5==e||d,h=t||l;return function(t,l,p){for(var m,v,_=a(t),y=o(_),b=r(l,p,3),g=i(y.length),x=0,k=n?h(t,g):s?h(t,0):void 0;g>x;x++)if((f||x in y)&&(v=b(m=y[x],x,_),e))if(n)k[x]=v;else if(v)switch(e){case 3:return!0;case 5:return m;case 6:return x;case 2:k.push(m)}else if(c)return!1;return d?-1:u||c?c:k}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){"use strict";var r=n(8),o=n(66)(2);r(r.P+r.F*!n(47)([].filter,!0),"Array",{filter:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(23),o=n(5),a=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(e.exports=function(e,t){return a[e]||(a[e]=void 0!==t?t:{})})("versions",[]).push({version:r.version,mode:n(70)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports=!1},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t,n){var r=n(15),o=n(5).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t,n){var r=n(138),o=n(99);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t,n){var r=n(69)("keys"),o=n(71);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){var r=n(29).f,o=n(48),a=n(2)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,a)&&r(e,a,{configurable:!0,value:t})}},function(e,t,n){var r=n(24),o=n(2)("toStringTag"),a="Arguments"==r(function(){return arguments}());e.exports=function(e){var t,n,i;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(n=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),o))?n:a?r(t):"Object"==(i=r(t))&&"function"==typeof t.callee?"Arguments":i}},function(e,t,n){var r=n(6),o=n(3).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t,n){var r=n(6);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},function(e,t,n){var r=n(38);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){var r=n(82)("keys"),o=n(52);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){var r=n(0),o=n(3),a=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(e.exports=function(e,t){return a[e]||(a[e]=void 0!==t?t:{})})("versions",[]).push({version:r.version,mode:n(39)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){"use strict";var r=n(8),o=n(66)(0),a=n(47)([].forEach,!0);r(r.P+r.F*!a,"Array",{forEach:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(1),o=n(0),a=n(16);e.exports=function(e,t){var n=(o.Object||{})[e]||Object[e],i={};i[e]=t(n),r(r.S+r.F*a(function(){n(1)}),"Object",i)}},function(e,t,n){var r=n(108),o=n(83).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return r(e,o)}},function(e,t,n){var r=n(54),o=n(36),a=n(19),i=n(78),l=n(18),s=n(107),u=Object.getOwnPropertyDescriptor;t.f=n(10)?u:function(e,t){if(e=a(e),t=i(t,!0),s)try{return u(e,t)}catch(e){}if(l(e,t))return o(!r.f.call(e,t),e[t])}},function(e,t,n){"use strict";var r=n(39),o=n(1),a=n(111),i=n(14),l=n(26),s=n(196),u=n(41),c=n(109),d=n(4)("iterator"),f=!([].keys&&"next"in[].keys()),h=function(){return this};e.exports=function(e,t,n,p,m,v,_){s(n,t,p);var y,b,g,x=function(e){if(!f&&e in A)return A[e];switch(e){case"keys":case"values":return function(){return new n(this,e)}}return function(){return new n(this,e)}},k=t+" Iterator",E="values"==m,w=!1,A=e.prototype,P=A[d]||A["@@iterator"]||m&&A[m],L=P||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&A.entries||P;if(S&&(g=c(S.call(new e)))!==Object.prototype&&g.next&&(u(g,k,!0),r||"function"==typeof g[d]||i(g,d,h)),E&&P&&"values"!==P.name&&(w=!0,L=function(){return P.call(this)}),r&&!_||!f&&!w&&A[d]||i(A,d,L),l[t]=L,l[k]=h,m)if(y={values:E?L:x("values"),keys:v?L:x("keys"),entries:M},_)for(b in y)b in A||a(A,b,y[b]);else o(o.P+o.F*(f||w),t,y);return y}},function(e,t,n){t.f=n(4)},function(e,t,n){var r=n(3),o=n(0),a=n(39),i=n(89),l=n(7).f;e.exports=function(e){var t=o.Symbol||(o.Symbol=a?{}:r.Symbol||{});"_"==e.charAt(0)||e in t||l(t,e,{value:i.f(e)})}},function(e,t,n){var r=n(38);e.exports=Array.isArray||function(e){return"Array"==r(e)}},function(e,t){},function(e,t){e.exports=function(e,t,n,r){if(!(e instanceof t)||void 0!==r&&r in e)throw TypeError(n+": incorrect invocation!");return e}},function(e,t,n){"use strict";var r=n(35);function o(e){var t,n;this.promise=new e(function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r}),this.resolve=r(t),this.reject=r(n)}e.exports.f=function(e){return new o(e)}},function(e,t,n){var r=n(14);e.exports=function(e,t,n){for(var o in t)n&&e[o]?e[o]=t[o]:r(e,o,t[o]);return e}},function(e,t,n){e.exports=n(194)},function(e,t,n){e.exports=n(221)},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){"use strict";var r=n(148),o=n(149),a=n(32),i=n(65);e.exports=n(101)(Array,"Array",function(e,t){this._t=i(e),this._i=0,this._k=t},function(){var e=this._t,t=this._k,n=this._i++;return!e||n>=e.length?(this._t=void 0,o(1)):o(0,"keys"==t?n:"values"==t?e[n]:[n,e[n]])},"values"),a.Arguments=a.Array,r("keys"),r("values"),r("entries")},function(e,t,n){"use strict";var r=n(70),o=n(8),a=n(30),i=n(17),l=n(32),s=n(151),u=n(75),c=n(155),d=n(2)("iterator"),f=!([].keys&&"next"in[].keys()),h=function(){return this};e.exports=function(e,t,n,p,m,v,_){s(n,t,p);var y,b,g,x=function(e){if(!f&&e in A)return A[e];switch(e){case"keys":case"values":return function(){return new n(this,e)}}return function(){return new n(this,e)}},k=t+" Iterator",E="values"==m,w=!1,A=e.prototype,P=A[d]||A["@@iterator"]||m&&A[m],L=P||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&A.entries||P;if(S&&(g=c(S.call(new e)))!==Object.prototype&&g.next&&(u(g,k,!0),r||"function"==typeof g[d]||i(g,d,h)),E&&P&&"values"!==P.name&&(w=!0,L=function(){return P.call(this)}),r&&!_||!f&&!w&&A[d]||i(A,d,L),l[t]=L,l[k]=h,m)if(y={values:E?L:x("values"),keys:v?L:x("keys"),entries:M},_)for(b in y)b in A||a(A,b,y[b]);else o(o.P+o.F*(f||w),t,y);return y}},function(e,t,n){var r=n(5).document;e.exports=r&&r.documentElement},function(e,t,n){var r=n(11),o=n(33),a=n(2)("species");e.exports=function(e,t){var n,i=r(e).constructor;return void 0===i||null==(n=r(i)[a])?t:o(n)}},function(e,t,n){var r,o,a,i=n(31),l=n(162),s=n(102),u=n(72),c=n(5),d=c.process,f=c.setImmediate,h=c.clearImmediate,p=c.MessageChannel,m=c.Dispatch,v=0,_={},y=function(){var e=+this;if(_.hasOwnProperty(e)){var t=_[e];delete _[e],t()}},b=function(e){y.call(e.data)};f&&h||(f=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return _[++v]=function(){l("function"==typeof e?e:Function(e),t)},r(v),v},h=function(e){delete _[e]},"process"==n(24)(d)?r=function(e){d.nextTick(i(y,e,1))}:m&&m.now?r=function(e){m.now(i(y,e,1))}:p?(a=(o=new p).port2,o.port1.onmessage=b,r=i(a.postMessage,a,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(e){c.postMessage(e+"","*")},c.addEventListener("message",b,!1)):r="onreadystatechange"in u("script")?function(e){s.appendChild(u("script")).onreadystatechange=function(){s.removeChild(this),y.call(e)}}:function(e){setTimeout(i(y,e,1),0)}),e.exports={set:f,clear:h}},function(e,t,n){"use strict";var r=n(33);function o(e){var t,n;this.promise=new e(function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r}),this.resolve=r(t),this.reject=r(n)}e.exports.f=function(e){return new o(e)}},function(e,t,n){var r=n(11),o=n(15),a=n(105);e.exports=function(e,t){if(r(e),o(t)&&t.constructor===e)return t;var n=a.f(e);return(0,n.resolve)(t),n.promise}},function(e,t,n){e.exports=!n(10)&&!n(16)(function(){return 7!=Object.defineProperty(n(77)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(18),o=n(19),a=n(178)(!1),i=n(81)("IE_PROTO");e.exports=function(e,t){var n,l=o(e),s=0,u=[];for(n in l)n!=i&&r(l,n)&&u.push(n);for(;t.length>s;)r(l,n=t[s++])&&(~a(u,n)||u.push(n));return u}},function(e,t,n){var r=n(18),o=n(25),a=n(81)("IE_PROTO"),i=Object.prototype;e.exports=Object.getPrototypeOf||function(e){return e=o(e),r(e,a)?e[a]:"function"==typeof e.constructor&&e instanceof e.constructor?e.constructor.prototype:e instanceof Object?i:null}},function(e,t,n){"use strict";var r=n(7),o=n(36);e.exports=function(e,t,n){t in e?r.f(e,t,o(0,n)):e[t]=n}},function(e,t,n){e.exports=n(14)},function(e,t,n){var r=n(3).document;e.exports=r&&r.documentElement},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,n){e.exports=n(206)},function(e,t,n){var r=n(9);e.exports=function(e,t,n,o){try{return o?t(r(n)[0],n[1]):t(n)}catch(t){var a=e.return;throw void 0!==a&&r(a.call(e)),t}}},function(e,t,n){var r=n(26),o=n(4)("iterator"),a=Array.prototype;e.exports=function(e){return void 0!==e&&(r.Array===e||a[o]===e)}},function(e,t,n){var r=n(59),o=n(4)("iterator"),a=n(26);e.exports=n(0).getIteratorMethod=function(e){if(null!=e)return e[o]||e["@@iterator"]||a[r(e)]}},function(e,t,n){var r=n(4)("iterator"),o=!1;try{var a=[7][r]();a.return=function(){o=!0},Array.from(a,function(){throw 2})}catch(e){}e.exports=function(e,t){if(!t&&!o)return!1;var n=!1;try{var a=[7],i=a[r]();i.next=function(){return{done:n=!0}},a[r]=function(){return i},e(a)}catch(e){}return n}},function(e,t,n){var r=n(29).f,o=Function.prototype,a=/^\s*function ([^ (]*)/;"name"in o||n(21)&&r(o,"name",{configurable:!0,get:function(){try{return(""+this).match(a)[1]}catch(e){return""}}})},function(e,t,n){var r=n(9),o=n(35),a=n(4)("species");e.exports=function(e,t){var n,i=r(e).constructor;return void 0===i||null==(n=r(i)[a])?t:o(n)}},function(e,t,n){var r,o,a,i=n(12),l=n(215),s=n(112),u=n(77),c=n(3),d=c.process,f=c.setImmediate,h=c.clearImmediate,p=c.MessageChannel,m=c.Dispatch,v=0,_={},y=function(){var e=+this;if(_.hasOwnProperty(e)){var t=_[e];delete _[e],t()}},b=function(e){y.call(e.data)};f&&h||(f=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return _[++v]=function(){l("function"==typeof e?e:Function(e),t)},r(v),v},h=function(e){delete _[e]},"process"==n(38)(d)?r=function(e){d.nextTick(i(y,e,1))}:m&&m.now?r=function(e){m.now(i(y,e,1))}:p?(a=(o=new p).port2,o.port1.onmessage=b,r=i(a.postMessage,a,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(e){c.postMessage(e+"","*")},c.addEventListener("message",b,!1)):r="onreadystatechange"in u("script")?function(e){s.appendChild(u("script")).onreadystatechange=function(){s.removeChild(this),y.call(e)}}:function(e){setTimeout(i(y,e,1),0)}),e.exports={set:f,clear:h}},function(e,t){e.exports=function(e){try{return{e:!1,v:e()}}catch(e){return{e:!0,v:e}}}},function(e,t,n){var r=n(9),o=n(6),a=n(94);e.exports=function(e,t){if(r(e),o(t)&&t.constructor===e)return t;var n=a.f(e);return(0,n.resolve)(t),n.promise}},function(e,t,n){"use strict";var r=n(3),o=n(0),a=n(7),i=n(10),l=n(4)("species");e.exports=function(e){var t="function"==typeof o[e]?o[e]:r[e];i&&t&&!t[l]&&a.f(t,l,{configurable:!0,get:function(){return this}})}},function(e,t,n){var r=n(50),o=n(28);e.exports=function(e){return function(t,n){var a,i,l=String(o(t)),s=r(n),u=l.length;return s<0||s>=u?e?"":void 0:(a=l.charCodeAt(s))<55296||a>56319||s+1===u||(i=l.charCodeAt(s+1))<56320||i>57343?e?l.charAt(s):a:e?l.slice(s,s+2):i-56320+(a-55296<<10)+65536}}},function(e,t,n){var r=n(6);e.exports=function(e,t){if(!r(e)||e._t!==t)throw TypeError("Incompatible receiver, "+t+" required!");return e}},function(e,t,n){"use strict";var r,o,a=n(146),i=RegExp.prototype.exec,l=String.prototype.replace,s=i,u=(r=/a/,o=/b*/g,i.call(r,"a"),i.call(o,"a"),0!==r.lastIndex||0!==o.lastIndex),c=void 0!==/()??/.exec("")[1];(u||c)&&(s=function(e){var t,n,r,o,s=this;return c&&(n=new RegExp("^"+s.source+"$(?!\\s)",a.call(s))),u&&(t=s.lastIndex),r=i.call(s,e),u&&r&&(s.lastIndex=s.global?r.index+r[0].length:t),c&&r&&r.length>1&&l.call(r[0],n,function(){for(o=1;o=t||n<0||f&&e-c>=i}function x(){var e=v();if(g(e))return k(e);s=setTimeout(x,function(e){var n=t-(e-u);return f?m(n,i-(e-c)):n}(e))}function k(e){return s=void 0,h&&o?_(e):(o=a=void 0,l)}function E(){var e=v(),n=g(e);if(o=arguments,a=this,u=e,n){if(void 0===s)return function(e){return c=e,s=setTimeout(x,t),d?_(e):l}(u);if(f)return s=setTimeout(x,t),_(u)}return void 0===s&&(s=setTimeout(x,t)),l}return t=b(t)||0,y(r)&&(d=!!r.leading,i=(f="maxWait"in r)?p(b(r.maxWait)||0,t):i,h="trailing"in r?!!r.trailing:h),E.cancel=function(){void 0!==s&&clearTimeout(s),c=0,o=u=a=s=void 0},E.flush=function(){return void 0===s?l:k(v())},E}function y(e){var t=typeof e;return!!e&&("object"==t||"function"==t)}function b(e){if("number"==typeof e)return e;if(function(e){return"symbol"==typeof e||function(e){return!!e&&"object"==typeof e}(e)&&h.call(e)==o}(e))return r;if(y(e)){var t="function"==typeof e.valueOf?e.valueOf():e;e=y(t)?t+"":t}if("string"!=typeof e)return 0===e?e:+e;e=e.replace(a,"");var n=l.test(e);return n||s.test(e)?u(e.slice(2),n?2:8):i.test(e)?r:+e}e.exports=function(e,t,r){var o=!0,a=!0;if("function"!=typeof e)throw new TypeError(n);return y(r)&&(o="leading"in r?!!r.leading:o,a="trailing"in r?!!r.trailing:a),_(e,t,{leading:o,maxWait:t,trailing:a})}},function(e,t,n){e.exports=n(240)},function(e,t,n){e.exports=n(242)},function(e,t,n){"use strict";var r=n(11),o=n(34),a=n(22),i=n(50),l=n(143),s=n(144),u=Math.max,c=Math.min,d=Math.floor,f=/\$([$&`']|\d\d?|<[^>]*>)/g,h=/\$([$&`']|\d\d?)/g;n(145)("replace",2,function(e,t,n,p){return[function(r,o){var a=e(this),i=null==r?void 0:r[t];return void 0!==i?i.call(r,a,o):n.call(String(a),r,o)},function(e,t){var o=p(n,e,this,t);if(o.done)return o.value;var d=r(e),f=String(this),h="function"==typeof t;h||(t=String(t));var v=d.global;if(v){var _=d.unicode;d.lastIndex=0}for(var y=[];;){var b=s(d,f);if(null===b)break;if(y.push(b),!v)break;""===String(b[0])&&(d.lastIndex=l(f,a(d.lastIndex),_))}for(var g,x="",k=0,E=0;E=k&&(x+=f.slice(k,A)+O,k=A+w.length)}return x+f.slice(k)}];function m(e,t,r,a,i,l){var s=r+e.length,u=a.length,c=h;return void 0!==i&&(i=o(i),c=f),n.call(l,c,function(n,o){var l;switch(o.charAt(0)){case"$":return"$";case"&":return e;case"`":return t.slice(0,r);case"'":return t.slice(s);case"<":l=i[o.slice(1,-1)];break;default:var c=+o;if(0===c)return n;if(c>u){var f=d(c/10);return 0===f?n:f<=u?void 0===a[f-1]?o.charAt(1):a[f-1]+o.charAt(1):n}l=a[c-1]}return void 0===l?"":l})}})},function(e,t,n){e.exports=!n(21)&&!n(27)(function(){return 7!=Object.defineProperty(n(72)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(15);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},function(e,t,n){var r=n(48),o=n(65),a=n(139)(!1),i=n(74)("IE_PROTO");e.exports=function(e,t){var n,l=o(e),s=0,u=[];for(n in l)n!=i&&r(l,n)&&u.push(n);for(;t.length>s;)r(l,n=t[s++])&&(~a(u,n)||u.push(n));return u}},function(e,t,n){var r=n(65),o=n(22),a=n(154);e.exports=function(e){return function(t,n,i){var l,s=r(t),u=o(s.length),c=a(i,u);if(e&&n!=n){for(;u>c;)if((l=s[c++])!=l)return!0}else for(;u>c;c++)if((e||c in s)&&s[c]===n)return e||c||0;return!e&&-1}}},function(e,t,n){"use strict";var r=n(5),o=n(29),a=n(21),i=n(2)("species");e.exports=function(e){var t=r[e];a&&t&&!t[i]&&o.f(t,i,{configurable:!0,get:function(){return this}})}},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,n){var r=n(15),o=n(24),a=n(2)("match");e.exports=function(e){var t;return r(e)&&(void 0!==(t=e[a])?!!t:"RegExp"==o(e))}},function(e,t,n){"use strict";var r=n(125)(!0);e.exports=function(e,t,n){return t+(n?r(e,t).length:1)}},function(e,t,n){"use strict";var r=n(76),o=RegExp.prototype.exec;e.exports=function(e,t){var n=e.exec;if("function"==typeof n){var a=n.call(e,t);if("object"!=typeof a)throw new TypeError("RegExp exec method returned something other than an Object or null");return a}if("RegExp"!==r(e))throw new TypeError("RegExp#exec called on incompatible receiver");return o.call(e,t)}},function(e,t,n){"use strict";n(244);var r=n(30),o=n(17),a=n(27),i=n(28),l=n(2),s=n(127),u=l("species"),c=!a(function(){var e=/./;return e.exec=function(){var e=[];return e.groups={a:"7"},e},"7"!=="".replace(e,"$")}),d=function(){var e=/(?:)/,t=e.exec;e.exec=function(){return t.apply(this,arguments)};var n="ab".split(e);return 2===n.length&&"a"===n[0]&&"b"===n[1]}();e.exports=function(e,t,n){var f=l(e),h=!a(function(){var t={};return t[f]=function(){return 7},7!=""[e](t)}),p=h?!a(function(){var t=!1,n=/a/;return n.exec=function(){return t=!0,null},"split"===e&&(n.constructor={},n.constructor[u]=function(){return n}),n[f](""),!t}):void 0;if(!h||!p||"replace"===e&&!c||"split"===e&&!d){var m=/./[f],v=n(i,f,""[e],function(e,t,n,r,o){return t.exec===s?h&&!o?{done:!0,value:m.call(t,n,r)}:{done:!0,value:e.call(n,t,r)}:{done:!1}}),_=v[0],y=v[1];r(String.prototype,e,_),o(RegExp.prototype,f,2==t?function(e,t){return y.call(e,this,t)}:function(e){return y.call(e,this)})}}},function(e,t,n){"use strict";var r=n(11);e.exports=function(){var e=r(this),t="";return e.global&&(t+="g"),e.ignoreCase&&(t+="i"),e.multiline&&(t+="m"),e.unicode&&(t+="u"),e.sticky&&(t+="y"),t}},function(e,t,n){e.exports=n(246)},function(e,t,n){var r=n(2)("unscopables"),o=Array.prototype;null==o[r]&&n(17)(o,r,{}),e.exports=function(e){o[r][e]=!0}},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,n){e.exports=n(69)("native-function-to-string",Function.toString)},function(e,t,n){"use strict";var r=n(152),o=n(98),a=n(75),i={};n(17)(i,n(2)("iterator"),function(){return this}),e.exports=function(e,t,n){e.prototype=r(i,{next:o(1,n)}),a(e,t+" Iterator")}},function(e,t,n){var r=n(11),o=n(153),a=n(99),i=n(74)("IE_PROTO"),l=function(){},s=function(){var e,t=n(72)("iframe"),r=a.length;for(t.style.display="none",n(102).appendChild(t),t.src="javascript:",(e=t.contentWindow.document).open(),e.write(" +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/chainspec/index.html b/docs/chainspec/index.html index 3fb5bd5a2..6bf500789 100644 --- a/docs/chainspec/index.html +++ b/docs/chainspec/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/chainspec

Chainspecs for known chains

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/chainspec

Chainspecs for known chains

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/chainspec/modules/_bbqbirch_.html b/docs/chainspec/modules/_bbqbirch_.html index 18563931f..278fb2594 100644 --- a/docs/chainspec/modules/_bbqbirch_.html +++ b/docs/chainspec/modules/_bbqbirch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/chainspec/modules/_krummelanke_.html b/docs/chainspec/modules/_krummelanke_.html index 6c9fa16c6..836ff38fc 100644 --- a/docs/chainspec/modules/_krummelanke_.html +++ b/docs/chainspec/modules/_krummelanke_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/chainspec/modules/_types_.html b/docs/chainspec/modules/_types_.html index e50a7e12c..3f6dc148c 100644 --- a/docs/chainspec/modules/_types_.html +++ b/docs/chainspec/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Chainspec

Ƭ Chainspec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Chainspec

Ƭ Chainspec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/chainspec/modules/_types_.md b/docs/chainspec/modules/_types_.md index a3c977d2e..40f1640be 100644 --- a/docs/chainspec/modules/_types_.md +++ b/docs/chainspec/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ Chainspec**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/chainspec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/chainspec/src/types.ts#L5)* #### Type declaration diff --git a/docs/db/SUMMARY.html b/docs/db/SUMMARY.html index 84cc8b717..5d9b76fcc 100644 --- a/docs/db/SUMMARY.html +++ b/docs/db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/db/classes/_disk_.diskdb.html b/docs/db/classes/_disk_.diskdb.html index 222a80e5e..94ebdccb3 100644 --- a/docs/db/classes/_disk_.diskdb.html +++ b/docs/db/classes/_disk_.diskdb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

name: DiskDb

summary: Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.

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

example:

import stringToU8a from '@polkadot/util/string/toU8a';
+

name: DiskDb

summary: Creates DiskDb database using LruDb for caching with FileFlatDb and extending TransactionDb.

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

example:

import stringToU8a from '@polkadot/util/string/toU8a';
 import DiskDb from '@polkadot/db/Disk';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
 
@@ -58,7 +58,7 @@ console.log<
 
 // Close the diskDb database and clear Lru cache
 diskDb.close();
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Hierarchy

TransactionDb

↳ DiskDb

Implements

Constructors

constructor

⊕ new DiskDb(base: string, name: string, options?: BaseDbOptions): DiskDb

Overrides TransactionDb.constructor

Defined in Disk.ts:66

Parameters:

Name Type
base string
name string
Optional options BaseDbOptions

Returns: DiskDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Hierarchy

TransactionDb

↳ DiskDb

Implements

Constructors

constructor

⊕ new DiskDb(base: string, name: string, options?: BaseDbOptions): DiskDb

Overrides TransactionDb.constructor

Defined in Disk.ts:66

Parameters:

Name Type
base string
name string
Optional options BaseDbOptions

Returns: DiskDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_disk_.diskdb.md b/docs/db/classes/_disk_.diskdb.md index f23a52c8e..45739da94 100644 --- a/docs/db/classes/_disk_.diskdb.md +++ b/docs/db/classes/_disk_.diskdb.md @@ -74,7 +74,7 @@ diskDb.close(); *Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)* -*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/Disk.ts#L66)* +*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Disk.ts#L66)* **Parameters:** @@ -100,7 +100,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)* -*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -115,7 +115,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)* -*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -136,7 +136,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)* -*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -151,7 +151,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)* -*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -166,7 +166,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)* -*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -187,7 +187,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)* -*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -208,7 +208,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)* -*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -223,7 +223,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)* -*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -245,7 +245,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)* -*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -267,7 +267,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)* -*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -280,7 +280,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)* -*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/classes/_engines_filetreedb_.filetreedb.html b/docs/db/classes/_engines_filetreedb_.filetreedb.html index bae0f1480..07d8f3990 100644 --- a/docs/db/classes/_engines_filetreedb_.filetreedb.html +++ b/docs/db/classes/_engines_filetreedb_.filetreedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

FileTreeDb

Implements

Constructors

constructor

⊕ new FileTreeDb(location: string): FileTreeDb

Defined in engines/FileTreeDb.ts:21

Parameters:

Name Type
location string

Returns: FileTreeDb

Properties

_location

● _location: string

Defined in engines/FileTreeDb.ts:21

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/FileTreeDb.ts:46

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/FileTreeDb.ts:76

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/FileTreeDb.ts:50

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/FileTreeDb.ts:54

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/FileTreeDb.ts:86

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/FileTreeDb.ts:68

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/FileTreeDb.ts:42

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/FileTreeDb.ts:100

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/FileTreeDb.ts:58

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/FileTreeDb.ts:62

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

FileTreeDb

Implements

Constructors

constructor

⊕ new FileTreeDb(location: string): FileTreeDb

Defined in engines/FileTreeDb.ts:21

Parameters:

Name Type
location string

Returns: FileTreeDb

Properties

_location

● _location: string

Defined in engines/FileTreeDb.ts:21

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/FileTreeDb.ts:46

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/FileTreeDb.ts:76

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/FileTreeDb.ts:50

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/FileTreeDb.ts:54

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/FileTreeDb.ts:86

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/FileTreeDb.ts:68

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/FileTreeDb.ts:42

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/FileTreeDb.ts:100

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/FileTreeDb.ts:58

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/FileTreeDb.ts:62

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_engines_filetreedb_.filetreedb.md b/docs/db/classes/_engines_filetreedb_.filetreedb.md index 69d9382bd..05f9e3cee 100644 --- a/docs/db/classes/_engines_filetreedb_.filetreedb.md +++ b/docs/db/classes/_engines_filetreedb_.filetreedb.md @@ -16,7 +16,7 @@ ⊕ **new FileTreeDb**(location: *`string`*): [FileTreeDb](_engines_filetreedb_.filetreedb.md) -*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/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/4b1681d/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21)* ___ @@ -50,7 +50,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L46)* +*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L46)* **Returns:** `void` @@ -63,7 +63,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L76)* +*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L76)* **Parameters:** @@ -82,7 +82,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L50)* +*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L50)* **Returns:** `void` @@ -95,7 +95,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L54)* +*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L54)* **Returns:** `void` @@ -108,7 +108,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L86)* +*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L86)* **Parameters:** @@ -127,7 +127,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L68)* +*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L68)* **Parameters:** @@ -146,7 +146,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L42)* +*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L42)* **Returns:** `void` @@ -159,7 +159,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L100)* +*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L100)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L58)* +*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L58)* **Parameters:** @@ -199,7 +199,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/FileTreeDb.ts#L62)* +*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/FileTreeDb.ts#L62)* **Returns:** `number` diff --git a/docs/db/classes/_engines_lrudb_.lrudb.html b/docs/db/classes/_engines_lrudb_.lrudb.html index 528290ed7..a82367bc6 100644 --- a/docs/db/classes/_engines_lrudb_.lrudb.html +++ b/docs/db/classes/_engines_lrudb_.lrudb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

LruDb

Implements

Constructors

constructor

⊕ new LruDb(backing: BaseDb, itemCount?: number): LruDb

Defined in engines/LruDb.ts:20

Parameters:

Name Type Default value
backing BaseDb -
Default value itemCount number DEFAULT_ITEM_COUNT

Returns: LruDb

Methods

_getLru

▸ _getLru(key: Uint8Array): CachedValue | undefined

Defined in engines/LruDb.ts:87

Parameters:

Name Type
key Uint8Array

Returns: CachedValue | undefined

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/LruDb.ts:27

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/LruDb.ts:64

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/LruDb.ts:41

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/LruDb.ts:45

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/LruDb.ts:71

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/LruDb.ts:56

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/LruDb.ts:34

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/LruDb.ts:91

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/LruDb.ts:52

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/LruDb.ts:60

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

LruDb

Implements

Constructors

constructor

⊕ new LruDb(backing: BaseDb, itemCount?: number): LruDb

Defined in engines/LruDb.ts:20

Parameters:

Name Type Default value
backing BaseDb -
Default value itemCount number DEFAULT_ITEM_COUNT

Returns: LruDb

Methods

_getLru

▸ _getLru(key: Uint8Array): CachedValue | undefined

Defined in engines/LruDb.ts:87

Parameters:

Name Type
key Uint8Array

Returns: CachedValue | undefined

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/LruDb.ts:27

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/LruDb.ts:64

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/LruDb.ts:41

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/LruDb.ts:45

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/LruDb.ts:71

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/LruDb.ts:56

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/LruDb.ts:34

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/LruDb.ts:91

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/LruDb.ts:52

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/LruDb.ts:60

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_engines_lrudb_.lrudb.md b/docs/db/classes/_engines_lrudb_.lrudb.md index 796c43bb4..1d5afbba9 100644 --- a/docs/db/classes/_engines_lrudb_.lrudb.md +++ b/docs/db/classes/_engines_lrudb_.lrudb.md @@ -16,7 +16,7 @@ ⊕ **new LruDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md) -*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L20)* +*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L20)* **Parameters:** @@ -37,7 +37,7 @@ ___ ▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` \| `undefined` -*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L87)* +*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L87)* **Parameters:** @@ -56,7 +56,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L27)* +*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L27)* **Returns:** `void` @@ -69,7 +69,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L64)* +*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L64)* **Parameters:** @@ -88,7 +88,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L41)* +*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L41)* **Returns:** `void` @@ -101,7 +101,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L45)* +*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L45)* **Returns:** `void` @@ -114,7 +114,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L71)* +*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L71)* **Parameters:** @@ -133,7 +133,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L56)* +*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L56)* **Parameters:** @@ -152,7 +152,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L34)* +*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L34)* **Returns:** `void` @@ -165,7 +165,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L91)* +*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L91)* **Parameters:** @@ -185,7 +185,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L52)* +*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L52)* **Parameters:** @@ -205,7 +205,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/LruDb.ts#L60)* +*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/LruDb.ts#L60)* **Returns:** `number` diff --git a/docs/db/classes/_engines_memorydb_.memorydb.html b/docs/db/classes/_engines_memorydb_.memorydb.html index 407637100..b65f14793 100644 --- a/docs/db/classes/_engines_memorydb_.memorydb.html +++ b/docs/db/classes/_engines_memorydb_.memorydb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

MemoryDb

Implements

Constructors

constructor

⊕ new MemoryDb(options?: BaseDbOptions): MemoryDb

Defined in engines/MemoryDb.ts:16

Parameters:

Name Type
Optional options BaseDbOptions

Returns: MemoryDb

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/MemoryDb.ts:22

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/MemoryDb.ts:56

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/MemoryDb.ts:30

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/MemoryDb.ts:34

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/MemoryDb.ts:62

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/MemoryDb.ts:42

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/MemoryDb.ts:26

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/MemoryDb.ts:68

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/MemoryDb.ts:38

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/MemoryDb.ts:50

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

MemoryDb

Implements

Constructors

constructor

⊕ new MemoryDb(options?: BaseDbOptions): MemoryDb

Defined in engines/MemoryDb.ts:16

Parameters:

Name Type
Optional options BaseDbOptions

Returns: MemoryDb

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in engines/MemoryDb.ts:22

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in engines/MemoryDb.ts:56

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in engines/MemoryDb.ts:30

Returns: void

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in engines/MemoryDb.ts:34

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in engines/MemoryDb.ts:62

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in engines/MemoryDb.ts:42

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of BaseDb.open

Defined in engines/MemoryDb.ts:26

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in engines/MemoryDb.ts:68

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in engines/MemoryDb.ts:38

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of BaseDb.size

Defined in engines/MemoryDb.ts:50

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_engines_memorydb_.memorydb.md b/docs/db/classes/_engines_memorydb_.memorydb.md index 5fec9824c..5ee06e2d1 100644 --- a/docs/db/classes/_engines_memorydb_.memorydb.md +++ b/docs/db/classes/_engines_memorydb_.memorydb.md @@ -16,7 +16,7 @@ ⊕ **new MemoryDb**(options?: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [MemoryDb](_engines_memorydb_.memorydb.md) -*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L16)* +*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L16)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)* -*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L22)* +*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L22)* **Returns:** `void` @@ -51,7 +51,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)* -*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L56)* +*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L56)* **Parameters:** @@ -70,7 +70,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)* -*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L30)* +*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L30)* **Returns:** `void` @@ -83,7 +83,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)* -*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L34)* +*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L34)* **Returns:** `void` @@ -96,7 +96,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)* -*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L62)* +*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L62)* **Parameters:** @@ -115,7 +115,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)* -*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L42)* +*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L42)* **Parameters:** @@ -134,7 +134,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)* -*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L26)* +*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L26)* **Returns:** `void` @@ -147,7 +147,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)* -*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L68)* +*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L68)* **Parameters:** @@ -167,7 +167,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)* -*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L38)* +*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L38)* **Parameters:** @@ -187,7 +187,7 @@ ___ *Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)* -*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/MemoryDb.ts#L50)* +*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/MemoryDb.ts#L50)* **Returns:** `number` diff --git a/docs/db/classes/_engines_transactiondb_.transactiondb.html b/docs/db/classes/_engines_transactiondb_.transactiondb.html index b9d11817e..1308b48f3 100644 --- a/docs/db/classes/_engines_transactiondb_.transactiondb.html +++ b/docs/db/classes/_engines_transactiondb_.transactiondb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

TransactionDb

↳ DiskDb

↳ Memory

Implements

Constructors

constructor

⊕ new TransactionDb(backing: BaseDb): TransactionDb

Defined in engines/TransactionDb.ts:21

Parameters:

Name Type
backing BaseDb

Returns: TransactionDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

TransactionDb

↳ DiskDb

↳ Memory

Implements

Constructors

constructor

⊕ new TransactionDb(backing: BaseDb): TransactionDb

Defined in engines/TransactionDb.ts:21

Parameters:

Name Type
backing BaseDb

Returns: TransactionDb

Methods

close

▸ close(): void

Implementation of TxDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_engines_transactiondb_.transactiondb.md b/docs/db/classes/_engines_transactiondb_.transactiondb.md index a47d63d46..871715a2b 100644 --- a/docs/db/classes/_engines_transactiondb_.transactiondb.md +++ b/docs/db/classes/_engines_transactiondb_.transactiondb.md @@ -20,7 +20,7 @@ ⊕ **new TransactionDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*): [TransactionDb](_engines_transactiondb_.transactiondb.md) -*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L21)* +*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L21)* **Parameters:** @@ -42,7 +42,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[close](../interfaces/_types_.txdb.md#close)* -*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -55,7 +55,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[del](../interfaces/_types_.txdb.md#del)* -*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -74,7 +74,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[drop](../interfaces/_types_.txdb.md#drop)* -*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -87,7 +87,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[empty](../interfaces/_types_.txdb.md#empty)* -*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -100,7 +100,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[get](../interfaces/_types_.txdb.md#get)* -*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -119,7 +119,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[maintain](../interfaces/_types_.txdb.md#maintain)* -*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -138,7 +138,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[open](../interfaces/_types_.txdb.md#open)* -*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -151,7 +151,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[put](../interfaces/_types_.txdb.md#put)* -*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -171,7 +171,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[rename](../interfaces/_types_.txdb.md#rename)* -*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -191,7 +191,7 @@ ___ *Implementation of [TxDb](../interfaces/_types_.txdb.md).[size](../interfaces/_types_.txdb.md#size)* -*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -202,7 +202,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_cache_.cache.html b/docs/db/classes/_fileflatdb_cache_.cache.html index d75d945ed..a217348d3 100644 --- a/docs/db/classes/_fileflatdb_cache_.cache.html +++ b/docs/db/classes/_fileflatdb_cache_.cache.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

↳ File

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Cache(base: string, file: string, options: BaseDbOptions): Cache

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Cache

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

↳ File

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Cache(base: string, file: string, options: BaseDbOptions): Cache

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Cache

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_fileflatdb_cache_.cache.md b/docs/db/classes/_fileflatdb_cache_.cache.md index 3e744d759..9c25a1c87 100644 --- a/docs/db/classes/_fileflatdb_cache_.cache.md +++ b/docs/db/classes/_fileflatdb_cache_.cache.md @@ -18,7 +18,7 @@ *Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)* -*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_compact_.compact.html b/docs/db/classes/_fileflatdb_compact_.compact.html index c96d41ef1..e86129fc7 100644 --- a/docs/db/classes/_fileflatdb_compact_.compact.html +++ b/docs/db/classes/_fileflatdb_compact_.compact.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Compact

Constructors

constructor

⊕ new Compact(file: string): Compact

Defined in FileFlatDb/Compact.ts:17

Parameters:

Name Type
file string

Returns: Compact

Methods

maintain

▸ maintain(fn: ProgressCb): void

Defined in FileFlatDb/Compact.ts:24

Parameters:

Name Type
fn ProgressCb

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Compact

Constructors

constructor

⊕ new Compact(file: string): Compact

Defined in FileFlatDb/Compact.ts:17

Parameters:

Name Type
file string

Returns: Compact

Methods

maintain

▸ maintain(fn: ProgressCb): void

Defined in FileFlatDb/Compact.ts:24

Parameters:

Name Type
fn ProgressCb

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_fileflatdb_compact_.compact.md b/docs/db/classes/_fileflatdb_compact_.compact.md index 33b0d024f..756342525 100644 --- a/docs/db/classes/_fileflatdb_compact_.compact.md +++ b/docs/db/classes/_fileflatdb_compact_.compact.md @@ -12,7 +12,7 @@ ⊕ **new Compact**(file: *`string`*): [Compact](_fileflatdb_compact_.compact.md) -*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Compact.ts#L17)* +*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L17)* **Parameters:** @@ -32,7 +32,7 @@ ___ ▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void` -*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Compact.ts#L24)* +*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L24)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_file_.file.html b/docs/db/classes/_fileflatdb_file_.file.html index 2e1346fb1..b29f9bd0d 100644 --- a/docs/db/classes/_fileflatdb_file_.file.html +++ b/docs/db/classes/_fileflatdb_file_.file.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Serialize

↳ File

↳ Cache

Constructors

constructor

⊕ new File(base: string, file: string, options: BaseDbOptions): File

Defined in FileFlatDb/File.ts:19

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: File

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Serialize

↳ File

↳ Cache

Constructors

constructor

⊕ new File(base: string, file: string, options: BaseDbOptions): File

Defined in FileFlatDb/File.ts:19

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: File

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_fileflatdb_file_.file.md b/docs/db/classes/_fileflatdb_file_.file.md index 2f7e81a8e..ca2012d41 100644 --- a/docs/db/classes/_fileflatdb_file_.file.md +++ b/docs/db/classes/_fileflatdb_file_.file.md @@ -16,7 +16,7 @@ ⊕ **new File**(base: *`string`*, file: *`string`*, options: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [File](_fileflatdb_file_.file.md) -*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/File.ts#L19)* +*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/File.ts#L19)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_impl_.impl.html b/docs/db/classes/_fileflatdb_impl_.impl.html index 80c9e7456..bdfb3e3e6 100644 --- a/docs/db/classes/_fileflatdb_impl_.impl.html +++ b/docs/db/classes/_fileflatdb_impl_.impl.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Impl(base: string, file: string, options: BaseDbOptions): Impl

Inherited from Cache.constructor

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Impl

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

↳ Cache

↳ Impl

Constructors

constructor

⊕ new Impl(base: string, file: string, options: BaseDbOptions): Impl

Inherited from Cache.constructor

Overrides File.constructor

Defined in FileFlatDb/Cache.ts:15

Parameters:

Name Type
base string
file string
options BaseDbOptions

Returns: Impl

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_fileflatdb_impl_.impl.md b/docs/db/classes/_fileflatdb_impl_.impl.md index 80d378759..e6091eddb 100644 --- a/docs/db/classes/_fileflatdb_impl_.impl.md +++ b/docs/db/classes/_fileflatdb_impl_.impl.md @@ -18,7 +18,7 @@ *Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)* -*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15)* **Parameters:** diff --git a/docs/db/classes/_fileflatdb_serialize_.serialize.html b/docs/db/classes/_fileflatdb_serialize_.serialize.html index b57d90500..0e307531a 100644 --- a/docs/db/classes/_fileflatdb_serialize_.serialize.html +++ b/docs/db/classes/_fileflatdb_serialize_.serialize.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Serialize

↳ File

Last Updated: 2/13/2019, 4:33:49 PM
- +

Hierarchy

Serialize

↳ File

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/classes/_memory_.memory.html b/docs/db/classes/_memory_.memory.html index cceb20aa5..f84f1d138 100644 --- a/docs/db/classes/_memory_.memory.html +++ b/docs/db/classes/_memory_.memory.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

name: MemoryDb

summary: Creates a MemoryDb database extending TransactionDb

description: Create an instance of a Memory database using MemoryDb and extending TransactionDb. options argument (optional) used to specifies whether to use compression.

  • Enable compression when storing "blocks" since they compress well.
  • 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:

import stringToU8a from '@polkadot/util/string/toU8a';
+

name: MemoryDb

summary: Creates a MemoryDb database extending TransactionDb

description: Create an instance of a Memory database using MemoryDb and extending TransactionDb. options argument (optional) used to specifies whether to use compression.

  • Enable compression when storing "blocks" since they compress well.
  • 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:

import stringToU8a from '@polkadot/util/string/toU8a';
 import MemoryDb from '@polkadot/db/Memory';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
 
@@ -53,7 +53,7 @@ console.log<
 
 // Close the memory database
 memoryDb.close();
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Hierarchy

TransactionDb

↳ Memory

Implements

Constructors

constructor

⊕ new Memory(options?: BaseDbOptions): Memory

Overrides TransactionDb.constructor

Defined in Memory.ts:66

Parameters:

Name Type
Optional options BaseDbOptions

Returns: Memory

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Hierarchy

TransactionDb

↳ Memory

Implements

Constructors

constructor

⊕ new Memory(options?: BaseDbOptions): Memory

Overrides TransactionDb.constructor

Defined in Memory.ts:66

Parameters:

Name Type
Optional options BaseDbOptions

Returns: Memory

Methods

close

▸ close(): void

Implementation of TxDb.close

Inherited from TransactionDb.close

Defined in engines/TransactionDb.ts:51

Returns: void

del

▸ del(key: Uint8Array): void

Implementation of TxDb.del

Inherited from TransactionDb.del

Defined in engines/TransactionDb.ts:81

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Implementation of TxDb.drop

Inherited from TransactionDb.drop

Defined in engines/TransactionDb.ts:59

Returns: void

empty

▸ empty(): void

Implementation of TxDb.empty

Inherited from TransactionDb.empty

Defined in engines/TransactionDb.ts:63

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TxDb.get

Inherited from TransactionDb.get

Defined in engines/TransactionDb.ts:93

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TxDb.maintain

Inherited from TransactionDb.maintain

Defined in engines/TransactionDb.ts:71

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Implementation of TxDb.open

Inherited from TransactionDb.open

Defined in engines/TransactionDb.ts:55

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TxDb.put

Inherited from TransactionDb.put

Defined in engines/TransactionDb.ts:107

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Implementation of TxDb.rename

Inherited from TransactionDb.rename

Defined in engines/TransactionDb.ts:67

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Implementation of TxDb.size

Inherited from TransactionDb.size

Defined in engines/TransactionDb.ts:77

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TransactionDb.transaction

Defined in engines/TransactionDb.ts:29

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/classes/_memory_.memory.md b/docs/db/classes/_memory_.memory.md index a38d4e122..078fc5b86 100644 --- a/docs/db/classes/_memory_.memory.md +++ b/docs/db/classes/_memory_.memory.md @@ -72,7 +72,7 @@ memoryDb.close(); *Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)* -*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/Memory.ts#L66)* +*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/Memory.ts#L66)* **Parameters:** @@ -96,7 +96,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)* -*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* **Returns:** `void` @@ -111,7 +111,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)* -*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* **Parameters:** @@ -132,7 +132,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)* -*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* **Returns:** `void` @@ -147,7 +147,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)* -*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* **Returns:** `void` @@ -162,7 +162,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)* -*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* **Parameters:** @@ -183,7 +183,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)* -*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* **Parameters:** @@ -204,7 +204,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)* -*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* **Returns:** `void` @@ -219,7 +219,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)* -*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* **Parameters:** @@ -241,7 +241,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)* -*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* **Parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)* -*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* **Returns:** `number` @@ -276,7 +276,7 @@ ___ *Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)* -*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* **Parameters:** diff --git a/docs/db/enums/_fileflatdb_types_.slot.html b/docs/db/enums/_fileflatdb_types_.slot.html index 15d2833b6..d01f33bd0 100644 --- a/docs/db/enums/_fileflatdb_types_.slot.html +++ b/docs/db/enums/_fileflatdb_types_.slot.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 1

Defined in FileFlatDb/types.ts:7

EMPTY

EMPTY: = 0

Defined in FileFlatDb/types.ts:6

LEAF

LEAF: = 2

Defined in FileFlatDb/types.ts:8

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 1

Defined in FileFlatDb/types.ts:7

EMPTY

EMPTY: = 0

Defined in FileFlatDb/types.ts:6

LEAF

LEAF: = 2

Defined in FileFlatDb/types.ts:8

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/enums/_fileflatdb_types_.slot.md b/docs/db/enums/_fileflatdb_types_.slot.md index 57eac6dbb..1c4fa4f62 100644 --- a/docs/db/enums/_fileflatdb_types_.slot.md +++ b/docs/db/enums/_fileflatdb_types_.slot.md @@ -18,7 +18,7 @@ **BRANCH**: = 1 -*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L7)* +*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L7)* ___ @@ -27,7 +27,7 @@ ___ **EMPTY**: = 0 -*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L6)* +*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L6)* ___ @@ -36,7 +36,7 @@ ___ **LEAF**: = 2 -*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L8)* +*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L8)* ___ diff --git a/docs/db/index.html b/docs/db/index.html index be19f1f7c..861b20daa 100644 --- a/docs/db/index.html +++ b/docs/db/index.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

@polkadot/db

This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client

Usage

Installation -

yarn add @polkadot/db
+

@polkadot/db

This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client

Usage

Installation -

yarn add @polkadot/db
1

Classes can be imported as follows:

// Default exports
 import DiskDb from '@polkadot/db/Disk';
 import MemoryDb from '@polkadot/db/Memory';
 import TransactionDb from '@polkadot/db/engines/TransactionDb';
1
2
3
4

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/db/interfaces/_types_.basedb.html b/docs/db/interfaces/_types_.basedb.html index 44bd4009f..3cdc1acc2 100644 --- a/docs/db/interfaces/_types_.basedb.html +++ b/docs/db/interfaces/_types_.basedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Defined in types.ts:24

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Defined in types.ts:24

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/interfaces/_types_.basedb.md b/docs/db/interfaces/_types_.basedb.md index f3fa95ad1..a8ebb2ce7 100644 --- a/docs/db/interfaces/_types_.basedb.md +++ b/docs/db/interfaces/_types_.basedb.md @@ -20,7 +20,7 @@ ▸ **close**(): `void` -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -31,7 +31,7 @@ ___ ▸ **del**(key: *`Uint8Array`*): `void` -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26)* **Parameters:** @@ -48,7 +48,7 @@ ___ ▸ **drop**(): `void` -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -59,7 +59,7 @@ ___ ▸ **empty**(): `void` -*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -70,7 +70,7 @@ ___ ▸ **get**(key: *`Uint8Array`*): `Uint8Array` \| `null` -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27)* **Parameters:** @@ -87,7 +87,7 @@ ___ ▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void` -*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22)* **Parameters:** @@ -104,7 +104,7 @@ ___ ▸ **open**(): `void` -*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -115,7 +115,7 @@ ___ ▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void` -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28)* **Parameters:** @@ -133,7 +133,7 @@ ___ ▸ **rename**(base: *`string`*, file: *`string`*): `void` -*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23)* **Parameters:** @@ -151,7 +151,7 @@ ___ ▸ **size**(): `number` -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24)* **Returns:** `number` diff --git a/docs/db/interfaces/_types_.txdb.html b/docs/db/interfaces/_types_.txdb.html index afb3a0901..bf767f6a4 100644 --- a/docs/db/interfaces/_types_.txdb.html +++ b/docs/db/interfaces/_types_.txdb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in types.ts:24

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

BaseDb

↳ TxDb

Implemented by

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in types.ts:24

Returns: number

transaction

▸ transaction(fn: function): boolean

Defined in types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/interfaces/_types_.txdb.md b/docs/db/interfaces/_types_.txdb.md index efb386f72..5fecbdc9d 100644 --- a/docs/db/interfaces/_types_.txdb.md +++ b/docs/db/interfaces/_types_.txdb.md @@ -22,7 +22,7 @@ *Inherited from [BaseDb](_types_.basedb.md).[close](_types_.basedb.md#close)* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -35,7 +35,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[del](_types_.basedb.md#del)* -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26)* **Parameters:** @@ -54,7 +54,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[drop](_types_.basedb.md#drop)* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -67,7 +67,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[empty](_types_.basedb.md#empty)* -*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -80,7 +80,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[get](_types_.basedb.md#get)* -*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27)* **Parameters:** @@ -99,7 +99,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[maintain](_types_.basedb.md#maintain)* -*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22)* **Parameters:** @@ -118,7 +118,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[open](_types_.basedb.md#open)* -*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -131,7 +131,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[put](_types_.basedb.md#put)* -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28)* **Parameters:** @@ -151,7 +151,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[rename](_types_.basedb.md#rename)* -*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23)* **Parameters:** @@ -171,7 +171,7 @@ ___ *Inherited from [BaseDb](_types_.basedb.md).[size](_types_.basedb.md#size)* -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24)* **Returns:** `number` @@ -182,7 +182,7 @@ ___ ▸ **transaction**(fn: *`function`*): `boolean` -*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/db/modules/_disk_.html b/docs/db/modules/_disk_.html index 5fb073147..3d79036ca 100644 --- a/docs/db/modules/_disk_.html +++ b/docs/db/modules/_disk_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_engines_filetreedb_.html b/docs/db/modules/_engines_filetreedb_.html index 480148d22..0e42fa62a 100644 --- a/docs/db/modules/_engines_filetreedb_.html +++ b/docs/db/modules/_engines_filetreedb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_engines_lrudb_.html b/docs/db/modules/_engines_lrudb_.html index 4d82da7cf..810625828 100644 --- a/docs/db/modules/_engines_lrudb_.html +++ b/docs/db/modules/_engines_lrudb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_engines_memorydb_.html b/docs/db/modules/_engines_memorydb_.html index b0ddcc235..832751acf 100644 --- a/docs/db/modules/_engines_memorydb_.html +++ b/docs/db/modules/_engines_memorydb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_engines_transactiondb_.html b/docs/db/modules/_engines_transactiondb_.html index 294008632..8527357c2 100644 --- a/docs/db/modules/_engines_transactiondb_.html +++ b/docs/db/modules/_engines_transactiondb_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_cache_.html b/docs/db/modules/_fileflatdb_cache_.html index a80fff09b..7ac942494 100644 --- a/docs/db/modules/_fileflatdb_cache_.html +++ b/docs/db/modules/_fileflatdb_cache_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_compact_.html b/docs/db/modules/_fileflatdb_compact_.html index 2e8191419..495e86bdb 100644 --- a/docs/db/modules/_fileflatdb_compact_.html +++ b/docs/db/modules/_fileflatdb_compact_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_defaults_.html b/docs/db/modules/_fileflatdb_defaults_.html index 97b74be88..beb6262a5 100644 --- a/docs/db/modules/_fileflatdb_defaults_.html +++ b/docs/db/modules/_fileflatdb_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_file_.html b/docs/db/modules/_fileflatdb_file_.html index 985c018db..627b13c89 100644 --- a/docs/db/modules/_fileflatdb_file_.html +++ b/docs/db/modules/_fileflatdb_file_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_impl_.html b/docs/db/modules/_fileflatdb_impl_.html index e64bc91cd..6cc5b7fd7 100644 --- a/docs/db/modules/_fileflatdb_impl_.html +++ b/docs/db/modules/_fileflatdb_impl_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_serialize_.html b/docs/db/modules/_fileflatdb_serialize_.html index a009a244c..95ad4c8bb 100644 --- a/docs/db/modules/_fileflatdb_serialize_.html +++ b/docs/db/modules/_fileflatdb_serialize_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_fileflatdb_types_.html b/docs/db/modules/_fileflatdb_types_.html index 5c8a589f6..742e8cf1c 100644 --- a/docs/db/modules/_fileflatdb_types_.html +++ b/docs/db/modules/_fileflatdb_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumerations

Type aliases

Type aliases

Key

Ƭ Key: object

Defined in FileFlatDb/types.ts:16

Type declaration

NibbleBuffer

Ƭ NibbleBuffer: object

Defined in FileFlatDb/types.ts:11

Type declaration

Value

Ƭ Value: object

Defined in FileFlatDb/types.ts:22

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumerations

Type aliases

Type aliases

Key

Ƭ Key: object

Defined in FileFlatDb/types.ts:16

Type declaration

NibbleBuffer

Ƭ NibbleBuffer: object

Defined in FileFlatDb/types.ts:11

Type declaration

Value

Ƭ Value: object

Defined in FileFlatDb/types.ts:22

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/modules/_fileflatdb_types_.md b/docs/db/modules/_fileflatdb_types_.md index a2b445c09..d99c31644 100644 --- a/docs/db/modules/_fileflatdb_types_.md +++ b/docs/db/modules/_fileflatdb_types_.md @@ -22,7 +22,7 @@ **Ƭ Key**: *`object`* -*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/FileFlatDb/types.ts#L16)* +*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/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/4b1681d/packages/db/src/FileFlatDb/types.ts#L11)* +*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/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/4b1681d/packages/db/src/FileFlatDb/types.ts#L22)* +*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/FileFlatDb/types.ts#L22)* #### Type declaration diff --git a/docs/db/modules/_memory_.html b/docs/db/modules/_memory_.html index cc9685208..e2c847e20 100644 --- a/docs/db/modules/_memory_.html +++ b/docs/db/modules/_memory_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/db/modules/_types_.html b/docs/db/modules/_types_.html index e83704b31..c1c20e6e4 100644 --- a/docs/db/modules/_types_.html +++ b/docs/db/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

BaseDbOptions

Ƭ BaseDbOptions: object

Defined in types.ts:13

Type declaration

ProgressCb

Ƭ ProgressCb: function

Defined in types.ts:11

Type declaration

▸(progress: ProgressValue): void

Parameters:

Name Type
progress ProgressValue

Returns: void

ProgressValue

Ƭ ProgressValue: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

BaseDbOptions

Ƭ BaseDbOptions: object

Defined in types.ts:13

Type declaration

ProgressCb

Ƭ ProgressCb: function

Defined in types.ts:11

Type declaration

▸(progress: ProgressValue): void

Parameters:

Name Type
progress ProgressValue

Returns: void

ProgressValue

Ƭ ProgressValue: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/db/modules/_types_.md b/docs/db/modules/_types_.md index 55d56902e..6aeb110a0 100644 --- a/docs/db/modules/_types_.md +++ b/docs/db/modules/_types_.md @@ -23,7 +23,7 @@ **Ƭ BaseDbOptions**: *`object`* -*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L13)* #### Type declaration @@ -34,7 +34,7 @@ ___ **Ƭ ProgressCb**: *`function`* -*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L11)* #### Type declaration ▸(progress: *[ProgressValue](_types_.md#progressvalue)*): `void` @@ -54,7 +54,7 @@ ___ **Ƭ ProgressValue**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L5)* #### Type declaration diff --git a/docs/examples/keyring/01_create_account/index.html b/docs/examples/keyring/01_create_account/index.html index 6c01e4346..364120c29 100644 --- a/docs/examples/keyring/01_create_account/index.html +++ b/docs/examples/keyring/01_create_account/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create Account

The following example shows how to create and account with keyring.

// Import Keyring class and utility function
+

Create Account

The following example shows how to create and account with keyring.

// Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;
 
@@ -39,6 +39,6 @@
         
         →
- + diff --git a/docs/examples/keyring/02_load_accounts/index.html b/docs/examples/keyring/02_load_accounts/index.html index d19c6ac82..edb69c231 100644 --- a/docs/examples/keyring/02_load_accounts/index.html +++ b/docs/examples/keyring/02_load_accounts/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Load Accounts

The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.

// Import Keyring class and utility function
+

Load Accounts

The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.

// Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;
 
@@ -51,10 +51,10 @@
          
-          /util/
+          @polkadot/util
         
         →
- + diff --git a/docs/examples/keyring/index.html b/docs/examples/keyring/index.html index 352e3fb4d..a70c46775 100644 --- a/docs/examples/keyring/index.html +++ b/docs/examples/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Keyring Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Keyring Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/01_create_patricia_trie/index.html b/docs/examples/trie-db/01_create_patricia_trie/index.html index d3c351c22..8f5eb6d50 100644 --- a/docs/examples/trie-db/01_create_patricia_trie/index.html +++ b/docs/examples/trie-db/01_create_patricia_trie/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create Patricia Trie

The following example shows how to create a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Create Patricia Trie

The following example shows how to create a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/02_get_set_del_trie_nodes/index.html b/docs/examples/trie-db/02_get_set_del_trie_nodes/index.html index f0b5b249d..a0e010038 100644 --- a/docs/examples/trie-db/02_get_set_del_trie_nodes/index.html +++ b/docs/examples/trie-db/02_get_set_del_trie_nodes/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Get & Set & Delete Trie Nodes

The following example shows how to get, set, and delete nodes of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Get & Set & Delete Trie Nodes

The following example shows how to get, set, and delete nodes of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/03_duplicate_trie_with_snapshot/index.html b/docs/examples/trie-db/03_duplicate_trie_with_snapshot/index.html index 4f43e7c17..b88b2a9b5 100644 --- a/docs/examples/trie-db/03_duplicate_trie_with_snapshot/index.html +++ b/docs/examples/trie-db/03_duplicate_trie_with_snapshot/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Duplicate Patricia Trie with Snapshot

The following example shows how to duplicate a Patricia Trie by taking a snapshot.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Duplicate Patricia Trie with Snapshot

The following example shows how to duplicate a Patricia Trie by taking a snapshot.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/04_show_size_trie_node_info/index.html b/docs/examples/trie-db/04_show_size_trie_node_info/index.html index 423356d6d..cc95cbee9 100644 --- a/docs/examples/trie-db/04_show_size_trie_node_info/index.html +++ b/docs/examples/trie-db/04_show_size_trie_node_info/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Show Size and Node Info of a Patricia Trie

The following example shows how to show the size and node information of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Show Size and Node Info of a Patricia Trie

The following example shows how to show the size and node information of a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/05_empty_close_drop_trie/index.html b/docs/examples/trie-db/05_empty_close_drop_trie/index.html index 5441010c4..c2c55d5ea 100644 --- a/docs/examples/trie-db/05_empty_close_drop_trie/index.html +++ b/docs/examples/trie-db/05_empty_close_drop_trie/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Empty & Close & Drop a Patricia Trie

The following example shows how to empty, close, and drop a Patricia Trie.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Empty & Close & Drop a Patricia Trie

The following example shows how to empty, close, and drop a Patricia Trie.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/trie-db/index.html b/docs/examples/trie-db/index.html index ffe1666e5..f9bec2503 100644 --- a/docs/examples/trie-db/index.html +++ b/docs/examples/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Trie-DB Examples

Here you will find a list of examples that takes you through the basics of creating a Patricia Trie, creating key/value pair branches, retrieving the value of a branch with its key, deleting branches, saving the root node hash to a variable and then later setting the root node hash to restore the trie to its previous state, duplicating the trie with a snapshot, showing the size of the trie and other node information, and emptying, closing, and dropping the trie.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Trie-DB Examples

Here you will find a list of examples that takes you through the basics of creating a Patricia Trie, creating key/value pair branches, retrieving the value of a branch with its key, deleting branches, saving the root node hash to a variable and then later setting the root node hash to restore the trie to its previous state, duplicating the trie with a snapshot, showing the size of the trie and other node information, and emptying, closing, and dropping the trie.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html b/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html index ebb86664f..3be137767 100644 --- a/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html +++ b/docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Encrypt & Decrypt Message using NaCl

The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Encrypt & Decrypt Message using NaCl

The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html b/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html index 64aaa7a3a..1b6a07a71 100644 --- a/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html +++ b/docs/examples/util-crypto/02_sign_verify_message_nacl/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Sign & Verify Message using NaCl

The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Sign & Verify Message using NaCl

The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html b/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html index db614bbe9..391ea8b95 100644 --- a/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html +++ b/docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Create & Generate Mnemonic using BIP39

The following example shows how to create and generate mnemonics using BIP39.

include

Last Updated: 2/13/2019, 4:33:49 PM
- +

Create & Generate Mnemonic using BIP39

The following example shows how to create and generate mnemonics using BIP39.

include

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/examples/util-crypto/index.html b/docs/examples/util-crypto/index.html index 5acbe0869..223276288 100644 --- a/docs/examples/util-crypto/index.html +++ b/docs/examples/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

Util-Crypto Examples

Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
+

Util-Crypto Examples

Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.

Running the examples

From within each folder run the following to install required dependencies and to execute the example:

yarn;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:33:49 PM
- +
1
2
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/index.html b/docs/index.html index 508eb0a65..96a21056a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Polkadot Javascript Common

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

It is split up into a number of internal packages, namely utilities -

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/common

Contributing

Contribution to Polkadot JS Common are more than welcome. You can report issues and log feature requests.

Last Updated: 2/26/2019, 10:14:20 AM
- +

Polkadot Javascript Common

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

It is split up into a number of internal packages, namely utilities -

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/

Github repositories

You can find the Polkadot repositories at:

This documentation is generated from https://github.com/polkadot-js/common

Contributing

Contribution to Polkadot JS Common are more than welcome. You can report issues and log feature requests.

Last Updated: 2/26/2019, 10:14:20 AM
+ diff --git a/docs/keyring/SUMMARY.html b/docs/keyring/SUMMARY.html index 45a92ae20..3cd81ecbf 100644 --- a/docs/keyring/SUMMARY.html +++ b/docs/keyring/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/keyring/classes/_pairs_.pairs.html b/docs/keyring/classes/_pairs_.pairs.html index c24e2a6f6..ea8c1426d 100644 --- a/docs/keyring/classes/_pairs_.pairs.html +++ b/docs/keyring/classes/_pairs_.pairs.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Pairs

Implements

Constructors

constructor

⊕ new Pairs(): Pairs

Defined in pairs.ts:17

Returns: Pairs

Methods

add

▸ add(pair: KeyringPair): KeyringPair

Defined in pairs.ts:23

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

▸ all(): Array<KeyringPair>

Defined in pairs.ts:30

Returns: Array<KeyringPair>

get

▸ get(address: string | Uint8Array): KeyringPair

Defined in pairs.ts:34

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

▸ remove(address: string | Uint8Array): void

Defined in pairs.ts:49

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Pairs

Implements

Constructors

constructor

⊕ new Pairs(): Pairs

Defined in pairs.ts:17

Returns: Pairs

Methods

add

▸ add(pair: KeyringPair): KeyringPair

Defined in pairs.ts:23

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

▸ all(): Array<KeyringPair>

Defined in pairs.ts:30

Returns: Array<KeyringPair>

get

▸ get(address: string | Uint8Array): KeyringPair

Defined in pairs.ts:34

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

▸ remove(address: string | Uint8Array): void

Defined in pairs.ts:49

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/classes/_pairs_.pairs.md b/docs/keyring/classes/_pairs_.pairs.md index c67f92953..d153d2fd1 100644 --- a/docs/keyring/classes/_pairs_.pairs.md +++ b/docs/keyring/classes/_pairs_.pairs.md @@ -16,7 +16,7 @@ ⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md) -*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L17)* +*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L17)* **Returns:** [Pairs](_pairs_.pairs.md) @@ -30,7 +30,7 @@ ___ ▸ **add**(pair: *[KeyringPair](../interfaces/_types_.keyringpair.md)*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L23)* +*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L23)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **all**(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)> -*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L30)* +*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L30)* **Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)> @@ -58,7 +58,7 @@ ___ ▸ **get**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L34)* +*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L34)* **Parameters:** @@ -75,7 +75,7 @@ ___ ▸ **remove**(address: *`string` \| `Uint8Array`*): `void` -*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pairs.ts#L49)* +*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pairs.ts#L49)* **Parameters:** diff --git a/docs/keyring/index.html b/docs/keyring/index.html index ecf513207..efdb4c02e 100644 --- a/docs/keyring/index.html +++ b/docs/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/keyring

Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage

Installation -

yarn add @polkadot/keyring
+

@polkadot/keyring

Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage

Installation -

yarn add @polkadot/keyring
1

Classes and Functions can be imported as follows:

import Keyring from '@polkadot/keyring';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← Contributing →

- + diff --git a/docs/keyring/interfaces/_types_.keyringinstance.html b/docs/keyring/interfaces/_types_.keyringinstance.html index 2615a57ef..42b57a2d4 100644 --- a/docs/keyring/interfaces/_types_.keyringinstance.html +++ b/docs/keyring/interfaces/_types_.keyringinstance.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringInstance

Properties

pairs

● pairs: Array<KeyringPair>

Defined in types.ts:58

publicKeys

● publicKeys: Array<Uint8Array>

Defined in types.ts:59

type

● type: KeyringPairType

Defined in types.ts:60

Methods

addFromAddress

▸ addFromAddress(address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeyringPairType): KeyringPair

Defined in types.ts:67

Parameters:

Name Type
address string | Uint8Array
Optional meta KeyringPair$Meta
Optional encoded Uint8Array | null
Optional type KeyringPairType

Returns: KeyringPair

addFromJson

▸ addFromJson(pair: KeyringPair$Json): KeyringPair

Defined in types.ts:70

Parameters:

Name Type
pair KeyringPair$Json

Returns: KeyringPair

addFromMnemonic

▸ addFromMnemonic(mnemonic: string, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:68

Parameters:

Name Type
mnemonic string
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addFromSeed

▸ addFromSeed(seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:69

Parameters:

Name Type
seed Uint8Array
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addPair

▸ addPair(pair: KeyringPair): KeyringPair

Defined in types.ts:66

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

decodeAddress

▸ decodeAddress(encoded: string | Uint8Array): Uint8Array

Defined in types.ts:62

Parameters:

Name Type
encoded string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: Uint8Array | string): string

Defined in types.ts:63

Parameters:

Name Type
key Uint8Array | string

Returns: string

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Defined in types.ts:71

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Defined in types.ts:72

Returns: Array<KeyringPair>

getPublicKeys

▸ getPublicKeys(): Array<Uint8Array>

Defined in types.ts:73

Returns: Array<Uint8Array>

removePair

▸ removePair(address: string | Uint8Array): void

Defined in types.ts:74

Parameters:

Name Type
address string | Uint8Array

Returns: void

setAddressPrefix

▸ setAddressPrefix(prefix: Prefix): void

Defined in types.ts:64

Parameters:

Name Type
prefix Prefix

Returns: void

toJson

▸ toJson(address: string | Uint8Array, passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:75

Parameters:

Name Type
address string | Uint8Array
Optional passphrase undefined | string

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringInstance

Properties

pairs

● pairs: Array<KeyringPair>

Defined in types.ts:58

publicKeys

● publicKeys: Array<Uint8Array>

Defined in types.ts:59

type

● type: KeyringPairType

Defined in types.ts:60

Methods

addFromAddress

▸ addFromAddress(address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeyringPairType): KeyringPair

Defined in types.ts:67

Parameters:

Name Type
address string | Uint8Array
Optional meta KeyringPair$Meta
Optional encoded Uint8Array | null
Optional type KeyringPairType

Returns: KeyringPair

addFromJson

▸ addFromJson(pair: KeyringPair$Json): KeyringPair

Defined in types.ts:70

Parameters:

Name Type
pair KeyringPair$Json

Returns: KeyringPair

addFromMnemonic

▸ addFromMnemonic(mnemonic: string, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:68

Parameters:

Name Type
mnemonic string
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addFromSeed

▸ addFromSeed(seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair

Defined in types.ts:69

Parameters:

Name Type
seed Uint8Array
Optional meta KeyringPair$Meta
Optional type KeyringPairType

Returns: KeyringPair

addPair

▸ addPair(pair: KeyringPair): KeyringPair

Defined in types.ts:66

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

decodeAddress

▸ decodeAddress(encoded: string | Uint8Array): Uint8Array

Defined in types.ts:62

Parameters:

Name Type
encoded string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: Uint8Array | string): string

Defined in types.ts:63

Parameters:

Name Type
key Uint8Array | string

Returns: string

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Defined in types.ts:71

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Defined in types.ts:72

Returns: Array<KeyringPair>

getPublicKeys

▸ getPublicKeys(): Array<Uint8Array>

Defined in types.ts:73

Returns: Array<Uint8Array>

removePair

▸ removePair(address: string | Uint8Array): void

Defined in types.ts:74

Parameters:

Name Type
address string | Uint8Array

Returns: void

setAddressPrefix

▸ setAddressPrefix(prefix: Prefix): void

Defined in types.ts:64

Parameters:

Name Type
prefix Prefix

Returns: void

toJson

▸ toJson(address: string | Uint8Array, passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:75

Parameters:

Name Type
address string | Uint8Array
Optional passphrase undefined | string

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringinstance.md b/docs/keyring/interfaces/_types_.keyringinstance.md index 40042dacc..918c75c98 100644 --- a/docs/keyring/interfaces/_types_.keyringinstance.md +++ b/docs/keyring/interfaces/_types_.keyringinstance.md @@ -12,7 +12,7 @@ **● pairs**: *`Array`<[KeyringPair](_types_.keyringpair.md)>* -*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L58)* ___ @@ -21,7 +21,7 @@ ___ **● publicKeys**: *`Array`<`Uint8Array`>* -*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L59)* ___ @@ -30,7 +30,7 @@ ___ **● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)* -*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L60)* ___ @@ -42,7 +42,7 @@ ___ ▸ **addFromAddress**(address: *`string` \| `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded?: *`Uint8Array` \| `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L67)* **Parameters:** @@ -62,7 +62,7 @@ ___ ▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L70)* **Parameters:** @@ -79,7 +79,7 @@ ___ ▸ **addFromMnemonic**(mnemonic: *`string`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L68)* **Parameters:** @@ -98,7 +98,7 @@ ___ ▸ **addFromSeed**(seed: *`Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L69)* **Parameters:** @@ -117,7 +117,7 @@ ___ ▸ **addPair**(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L66)* **Parameters:** @@ -134,7 +134,7 @@ ___ ▸ **decodeAddress**(encoded: *`string` \| `Uint8Array`*): `Uint8Array` -*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L62)* **Parameters:** @@ -151,7 +151,7 @@ ___ ▸ **encodeAddress**(key: *`Uint8Array` \| `string`*): `string` -*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L63)* **Parameters:** @@ -168,7 +168,7 @@ ___ ▸ **getPair**(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L71)* **Parameters:** @@ -185,7 +185,7 @@ ___ ▸ **getPairs**(): `Array`<[KeyringPair](_types_.keyringpair.md)> -*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L72)* **Returns:** `Array`<[KeyringPair](_types_.keyringpair.md)> @@ -196,7 +196,7 @@ ___ ▸ **getPublicKeys**(): `Array`<`Uint8Array`> -*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L73)* **Returns:** `Array`<`Uint8Array`> @@ -207,7 +207,7 @@ ___ ▸ **removePair**(address: *`string` \| `Uint8Array`*): `void` -*Defined in [types.ts:74](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L74)* **Parameters:** @@ -224,7 +224,7 @@ ___ ▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void` -*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L64)* **Parameters:** @@ -241,7 +241,7 @@ ___ ▸ **toJson**(address: *`string` \| `Uint8Array`*, passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) -*Defined in [types.ts:75](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L75)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpair.html b/docs/keyring/interfaces/_types_.keyringpair.html index 71e7a878c..4b2b986f4 100644 --- a/docs/keyring/interfaces/_types_.keyringpair.html +++ b/docs/keyring/interfaces/_types_.keyringpair.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringPair

Properties

address

● address: function

Defined in types.ts:36

Type declaration

▸(): string

Returns: string

decodePkcs8

● decodePkcs8: function

Defined in types.ts:37

Type declaration

▸(passphrase?: undefined | string, encoded?: Uint8Array): void

Parameters:

Name Type
Optional passphrase undefined | string
Optional encoded Uint8Array

Returns: void

encodePkcs8

● encodePkcs8: function

Defined in types.ts:38

Type declaration

▸(passphrase?: undefined | string): Uint8Array

Parameters:

Name Type
Optional passphrase undefined | string

Returns: Uint8Array

getMeta

● getMeta: function

Defined in types.ts:39

Type declaration

▸(): KeyringPair$Meta

Returns: KeyringPair$Meta

isLocked

● isLocked: function

Defined in types.ts:40

Type declaration

▸(): boolean

Returns: boolean

lock

● lock: function

Defined in types.ts:41

Type declaration

▸(): void

Returns: void

publicKey

● publicKey: function

Defined in types.ts:42

Type declaration

▸(): Uint8Array

Returns: Uint8Array

setMeta

● setMeta: function

Defined in types.ts:43

Type declaration

▸(meta: KeyringPair$Meta): void

Parameters:

Name Type
meta KeyringPair$Meta

Returns: void

type

● type: KeyringPairType

Defined in types.ts:34

Methods

sign

▸ sign(message: Uint8Array): Uint8Array

Defined in types.ts:44

Parameters:

Name Type
message Uint8Array

Returns: Uint8Array

toJson

▸ toJson(passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:45

Parameters:

Name Type
Optional passphrase undefined | string

Returns: KeyringPair$Json

toType

▸ toType(type: KeyringPairType): KeyringPair

Defined in types.ts:46

Parameters:

Name Type
type KeyringPairType

Returns: KeyringPair

verify

▸ verify(message: Uint8Array, signature: Uint8Array): boolean

Defined in types.ts:47

Parameters:

Name Type
message Uint8Array
signature Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringPair

Properties

address

● address: function

Defined in types.ts:36

Type declaration

▸(): string

Returns: string

decodePkcs8

● decodePkcs8: function

Defined in types.ts:37

Type declaration

▸(passphrase?: undefined | string, encoded?: Uint8Array): void

Parameters:

Name Type
Optional passphrase undefined | string
Optional encoded Uint8Array

Returns: void

encodePkcs8

● encodePkcs8: function

Defined in types.ts:38

Type declaration

▸(passphrase?: undefined | string): Uint8Array

Parameters:

Name Type
Optional passphrase undefined | string

Returns: Uint8Array

getMeta

● getMeta: function

Defined in types.ts:39

Type declaration

▸(): KeyringPair$Meta

Returns: KeyringPair$Meta

isLocked

● isLocked: function

Defined in types.ts:40

Type declaration

▸(): boolean

Returns: boolean

lock

● lock: function

Defined in types.ts:41

Type declaration

▸(): void

Returns: void

publicKey

● publicKey: function

Defined in types.ts:42

Type declaration

▸(): Uint8Array

Returns: Uint8Array

setMeta

● setMeta: function

Defined in types.ts:43

Type declaration

▸(meta: KeyringPair$Meta): void

Parameters:

Name Type
meta KeyringPair$Meta

Returns: void

type

● type: KeyringPairType

Defined in types.ts:34

Methods

sign

▸ sign(message: Uint8Array): Uint8Array

Defined in types.ts:44

Parameters:

Name Type
message Uint8Array

Returns: Uint8Array

toJson

▸ toJson(passphrase?: undefined | string): KeyringPair$Json

Defined in types.ts:45

Parameters:

Name Type
Optional passphrase undefined | string

Returns: KeyringPair$Json

toType

▸ toType(type: KeyringPairType): KeyringPair

Defined in types.ts:46

Parameters:

Name Type
type KeyringPairType

Returns: KeyringPair

verify

▸ verify(message: Uint8Array, signature: Uint8Array): boolean

Defined in types.ts:47

Parameters:

Name Type
message Uint8Array
signature Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringpair.md b/docs/keyring/interfaces/_types_.keyringpair.md index ba75bc75c..76f06e1ff 100644 --- a/docs/keyring/interfaces/_types_.keyringpair.md +++ b/docs/keyring/interfaces/_types_.keyringpair.md @@ -12,7 +12,7 @@ **● address**: *`function`* -*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L36)* #### Type declaration ▸(): `string` @@ -26,7 +26,7 @@ ___ **● decodePkcs8**: *`function`* -*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L37)* #### Type declaration ▸(passphrase?: *`undefined` \| `string`*, encoded?: *`Uint8Array`*): `void` @@ -47,7 +47,7 @@ ___ **● encodePkcs8**: *`function`* -*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L38)* #### Type declaration ▸(passphrase?: *`undefined` \| `string`*): `Uint8Array` @@ -67,7 +67,7 @@ ___ **● getMeta**: *`function`* -*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L39)* #### Type declaration ▸(): [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) @@ -81,7 +81,7 @@ ___ **● isLocked**: *`function`* -*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L40)* #### Type declaration ▸(): `boolean` @@ -95,7 +95,7 @@ ___ **● lock**: *`function`* -*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L41)* #### Type declaration ▸(): `void` @@ -109,7 +109,7 @@ ___ **● publicKey**: *`function`* -*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L42)* #### Type declaration ▸(): `Uint8Array` @@ -123,7 +123,7 @@ ___ **● setMeta**: *`function`* -*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L43)* #### Type declaration ▸(meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): `void` @@ -143,7 +143,7 @@ ___ **● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)* -*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L34)* ___ @@ -155,7 +155,7 @@ ___ ▸ **sign**(message: *`Uint8Array`*): `Uint8Array` -*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L44)* **Parameters:** @@ -172,7 +172,7 @@ ___ ▸ **toJson**(passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json) -*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L45)* **Parameters:** @@ -189,7 +189,7 @@ ___ ▸ **toType**(type: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md) -*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L46)* **Parameters:** @@ -206,7 +206,7 @@ ___ ▸ **verify**(message: *`Uint8Array`*, signature: *`Uint8Array`*): `boolean` -*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L47)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpairs.html b/docs/keyring/interfaces/_types_.keyringpairs.html index 37c600c4f..358aa46bf 100644 --- a/docs/keyring/interfaces/_types_.keyringpairs.html +++ b/docs/keyring/interfaces/_types_.keyringpairs.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

KeyringPairs

Implemented by

Properties

add

● add: function

Defined in types.ts:51

Type declaration

▸(pair: KeyringPair): KeyringPair

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

● all: function

Defined in types.ts:52

Type declaration

▸(): Array<KeyringPair>

Returns: Array<KeyringPair>

get

● get: function

Defined in types.ts:53

Type declaration

▸(address: string | Uint8Array): KeyringPair

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

● remove: function

Defined in types.ts:54

Type declaration

▸(address: string | Uint8Array): void

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

KeyringPairs

Implemented by

Properties

add

● add: function

Defined in types.ts:51

Type declaration

▸(pair: KeyringPair): KeyringPair

Parameters:

Name Type
pair KeyringPair

Returns: KeyringPair

all

● all: function

Defined in types.ts:52

Type declaration

▸(): Array<KeyringPair>

Returns: Array<KeyringPair>

get

● get: function

Defined in types.ts:53

Type declaration

▸(address: string | Uint8Array): KeyringPair

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

remove

● remove: function

Defined in types.ts:54

Type declaration

▸(address: string | Uint8Array): void

Parameters:

Name Type
address string | Uint8Array

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringpairs.md b/docs/keyring/interfaces/_types_.keyringpairs.md index 0aff5be4a..1546b99d6 100644 --- a/docs/keyring/interfaces/_types_.keyringpairs.md +++ b/docs/keyring/interfaces/_types_.keyringpairs.md @@ -16,7 +16,7 @@ **● add**: *`function`* -*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L51)* #### Type declaration ▸(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md) @@ -36,7 +36,7 @@ ___ **● all**: *`function`* -*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L52)* #### Type declaration ▸(): `Array`<[KeyringPair](_types_.keyringpair.md)> @@ -50,7 +50,7 @@ ___ **● get**: *`function`* -*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L53)* #### Type declaration ▸(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md) @@ -70,7 +70,7 @@ ___ **● remove**: *`function`* -*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L54)* #### Type declaration ▸(address: *`string` \| `Uint8Array`*): `void` diff --git a/docs/keyring/modules/_address_decode_.html b/docs/keyring/modules/_address_decode_.html index 9879f079f..061f6046d 100644 --- a/docs/keyring/modules/_address_decode_.html +++ b/docs/keyring/modules/_address_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(encoded: string | Uint8Array, prefix?: Prefix): Uint8Array

Defined in address/decode.ts:15

Parameters:

Name Type Default value
encoded string | Uint8Array -
Default value prefix Prefix defaults.prefix

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(encoded: string | Uint8Array, prefix?: Prefix): Uint8Array

Defined in address/decode.ts:15

Parameters:

Name Type Default value
encoded string | Uint8Array -
Default value prefix Prefix defaults.prefix

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_address_decode_.md b/docs/keyring/modules/_address_decode_.md index 4eb3b397f..027f5a585 100644 --- a/docs/keyring/modules/_address_decode_.md +++ b/docs/keyring/modules/_address_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(encoded: *`string` \| `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array` -*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/decode.ts#L15)* +*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/decode.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_address_defaults_.html b/docs/keyring/modules/_address_defaults_.html index 7de52eabc..b85d7b083 100644 --- a/docs/keyring/modules/_address_defaults_.html +++ b/docs/keyring/modules/_address_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/keyring/modules/_address_encode_.html b/docs/keyring/modules/_address_encode_.html index 6aec233d1..ce55b0acd 100644 --- a/docs/keyring/modules/_address_encode_.html +++ b/docs/keyring/modules/_address_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(_key: Uint8Array | string, prefix?: Prefix): string

Defined in address/encode.ts:15

Parameters:

Name Type Default value
_key Uint8Array | string -
Default value prefix Prefix defaults.prefix

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(_key: Uint8Array | string, prefix?: Prefix): string

Defined in address/encode.ts:15

Parameters:

Name Type Default value
_key Uint8Array | string -
Default value prefix Prefix defaults.prefix

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_address_encode_.md b/docs/keyring/modules/_address_encode_.md index af53e9f5b..d6642ebf7 100644 --- a/docs/keyring/modules/_address_encode_.md +++ b/docs/keyring/modules/_address_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(_key: *`Uint8Array` \| `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string` -*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/encode.ts#L15)* +*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/encode.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_address_setprefix_.html b/docs/keyring/modules/_address_setprefix_.html index cee397811..32d47f9e3 100644 --- a/docs/keyring/modules/_address_setprefix_.html +++ b/docs/keyring/modules/_address_setprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

setPrefix

▸ setPrefix(prefix: Prefix): void

Defined in address/setPrefix.ts:9

Parameters:

Name Type
prefix Prefix

Returns: void

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

setPrefix

▸ setPrefix(prefix: Prefix): void

Defined in address/setPrefix.ts:9

Parameters:

Name Type
prefix Prefix

Returns: void

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_address_setprefix_.md b/docs/keyring/modules/_address_setprefix_.md index 29ac63af6..40fda897f 100644 --- a/docs/keyring/modules/_address_setprefix_.md +++ b/docs/keyring/modules/_address_setprefix_.md @@ -8,7 +8,7 @@ ▸ **setPrefix**(prefix: *[Prefix](_address_types_.md#prefix)*): `void` -*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/setPrefix.ts#L9)* +*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/setPrefix.ts#L9)* **Parameters:** diff --git a/docs/keyring/modules/_address_types_.html b/docs/keyring/modules/_address_types_.html index 53ff215cd..7aa15d883 100644 --- a/docs/keyring/modules/_address_types_.html +++ b/docs/keyring/modules/_address_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Prefix

Ƭ Prefix: 0 | 1 | 3 | 42 | 43 | 68 | 69

Defined in address/types.ts:5

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Prefix

Ƭ Prefix: 0 | 1 | 3 | 42 | 43 | 68 | 69

Defined in address/types.ts:5

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_address_types_.md b/docs/keyring/modules/_address_types_.md index 4e41e6662..f3d6a736a 100644 --- a/docs/keyring/modules/_address_types_.md +++ b/docs/keyring/modules/_address_types_.md @@ -8,7 +8,7 @@ **Ƭ Prefix**: *`0` \| `1` \| `3` \| `42` \| `43` \| `68` \| `69`* -*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/address/types.ts#L5)* +*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/address/types.ts#L5)* ___ diff --git a/docs/keyring/modules/_pair_decode_.html b/docs/keyring/modules/_pair_decode_.html index 69eaeeda2..e26683b8e 100644 --- a/docs/keyring/modules/_pair_decode_.html +++ b/docs/keyring/modules/_pair_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(passphrase?: undefined | string, _encrypted?: Uint8Array | null): DecodeResult

Defined in pair/decode.ts:19

Parameters:

Name Type
Optional passphrase undefined | string
Optional _encrypted Uint8Array | null

Returns: DecodeResult

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(passphrase?: undefined | string, _encrypted?: Uint8Array | null): DecodeResult

Defined in pair/decode.ts:19

Parameters:

Name Type
Optional passphrase undefined | string
Optional _encrypted Uint8Array | null

Returns: DecodeResult

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_pair_decode_.md b/docs/keyring/modules/_pair_decode_.md index b7cc17bbf..587219c26 100644 --- a/docs/keyring/modules/_pair_decode_.md +++ b/docs/keyring/modules/_pair_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(passphrase?: *`undefined` \| `string`*, _encrypted?: *`Uint8Array` \| `null`*): `DecodeResult` -*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/decode.ts#L19)* +*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/decode.ts#L19)* **Parameters:** diff --git a/docs/keyring/modules/_pair_defaults_.html b/docs/keyring/modules/_pair_defaults_.html index a55a8392a..ef02b4954 100644 --- a/docs/keyring/modules/_pair_defaults_.html +++ b/docs/keyring/modules/_pair_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/keyring/modules/_pair_encode_.html b/docs/keyring/modules/_pair_encode_.html index d790cc53e..4e5bfbc9f 100644 --- a/docs/keyring/modules/_pair_encode_.html +++ b/docs/keyring/modules/_pair_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(__namedParameters: object, passphrase?: undefined | string): Uint8Array

Defined in pair/encode.ts:12

Parameters:

Name Type
__namedParameters object
Optional passphrase undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(__namedParameters: object, passphrase?: undefined | string): Uint8Array

Defined in pair/encode.ts:12

Parameters:

Name Type
__namedParameters object
Optional passphrase undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_pair_encode_.md b/docs/keyring/modules/_pair_encode_.md index ac654d7ac..284cd0b81 100644 --- a/docs/keyring/modules/_pair_encode_.md +++ b/docs/keyring/modules/_pair_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(__namedParameters: *`object`*, passphrase?: *`undefined` \| `string`*): `Uint8Array` -*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/encode.ts#L12)* +*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/encode.ts#L12)* **Parameters:** diff --git a/docs/keyring/modules/_pair_nobody_.html b/docs/keyring/modules/_pair_nobody_.html index fb5adb25b..3a5ef7ca5 100644 --- a/docs/keyring/modules/_pair_nobody_.html +++ b/docs/keyring/modules/_pair_nobody_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

everybody

▸ everybody(): KeyringPair

Defined in pair/nobody.ts:25

Returns: KeyringPair

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

everybody

▸ everybody(): KeyringPair

Defined in pair/nobody.ts:25

Returns: KeyringPair

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_pair_nobody_.md b/docs/keyring/modules/_pair_nobody_.md index 7e2890d7f..8cc29343b 100644 --- a/docs/keyring/modules/_pair_nobody_.md +++ b/docs/keyring/modules/_pair_nobody_.md @@ -8,7 +8,7 @@ ▸ **everybody**(): [KeyringPair](../interfaces/_types_.keyringpair.md) -*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/nobody.ts#L25)* +*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/nobody.ts#L25)* **Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md) diff --git a/docs/keyring/modules/_pair_tojson_.html b/docs/keyring/modules/_pair_tojson_.html index c30a65a05..8b47b23c8 100644 --- a/docs/keyring/modules/_pair_tojson_.html +++ b/docs/keyring/modules/_pair_tojson_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toJson

▸ toJson(type: KeyringPairType, __namedParameters: object, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json

Defined in pair/toJson.ts:15

Parameters:

Name Type
type KeyringPairType
__namedParameters object
encoded Uint8Array
isEncrypted boolean

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toJson

▸ toJson(type: KeyringPairType, __namedParameters: object, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json

Defined in pair/toJson.ts:15

Parameters:

Name Type
type KeyringPairType
__namedParameters object
encoded Uint8Array
isEncrypted boolean

Returns: KeyringPair$Json

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_pair_tojson_.md b/docs/keyring/modules/_pair_tojson_.md index 46249e5d1..1817bd69a 100644 --- a/docs/keyring/modules/_pair_tojson_.md +++ b/docs/keyring/modules/_pair_tojson_.md @@ -8,7 +8,7 @@ ▸ **toJson**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): [KeyringPair$Json](_types_.md#keyringpair_json) -*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/toJson.ts#L15)* +*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/toJson.ts#L15)* **Parameters:** diff --git a/docs/keyring/modules/_pair_types_.html b/docs/keyring/modules/_pair_types_.html index a39833aef..9b0b72dd6 100644 --- a/docs/keyring/modules/_pair_types_.html +++ b/docs/keyring/modules/_pair_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

PairInfo

Ƭ PairInfo: object

Defined in pair/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

PairInfo

Ƭ PairInfo: object

Defined in pair/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_pair_types_.md b/docs/keyring/modules/_pair_types_.md index 4386f4e40..2f7fe6066 100644 --- a/docs/keyring/modules/_pair_types_.md +++ b/docs/keyring/modules/_pair_types_.md @@ -8,7 +8,7 @@ **Ƭ PairInfo**: *`object`* -*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/pair/types.ts#L5)* +*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/pair/types.ts#L5)* #### Type declaration diff --git a/docs/keyring/modules/_pairs_.html b/docs/keyring/modules/_pairs_.html index ea990c3ae..9115a8495 100644 --- a/docs/keyring/modules/_pairs_.html +++ b/docs/keyring/modules/_pairs_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/keyring/modules/_testing_.html b/docs/keyring/modules/_testing_.html index f5cdd2e43..496cc3dda 100644 --- a/docs/keyring/modules/_testing_.html +++ b/docs/keyring/modules/_testing_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

testKeyring

▸ testKeyring(options?: KeyringOptions): KeyringInstance

Defined in testing.ts:41

name: testKeyring

summary: Create an instance of Keyring pre-populated with locked test accounts

description: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds.

Parameters:

Name Type
Optional options KeyringOptions

Returns: KeyringInstance

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

testKeyring

▸ testKeyring(options?: KeyringOptions): KeyringInstance

Defined in testing.ts:41

name: testKeyring

summary: Create an instance of Keyring pre-populated with locked test accounts

description: The test accounts (i.e. alice, bob, dave, eve, ferdie) are available on the dev chain and each test account is initialised with DOT funds.

Parameters:

Name Type
Optional options KeyringOptions

Returns: KeyringInstance

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_testing_.md b/docs/keyring/modules/_testing_.md index b6603b603..5cddf1708 100644 --- a/docs/keyring/modules/_testing_.md +++ b/docs/keyring/modules/_testing_.md @@ -8,7 +8,7 @@ ▸ **testKeyring**(options?: *[KeyringOptions](_types_.md#keyringoptions)*): [KeyringInstance](../interfaces/_types_.keyringinstance.md) -*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/testing.ts#L41)* +*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testing.ts#L41)* *__name__*: testKeyring diff --git a/docs/keyring/modules/_testingpairs_.html b/docs/keyring/modules/_testingpairs_.html index f5712cb4f..d6e5b0c77 100644 --- a/docs/keyring/modules/_testingpairs_.html +++ b/docs/keyring/modules/_testingpairs_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

testKeyringPairs

▸ testKeyringPairs(options?: KeyringOptions): TestKeyringMap

Defined in testingPairs.ts:14

Parameters:

Name Type
Optional options KeyringOptions

Returns: TestKeyringMap

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

testKeyringPairs

▸ testKeyringPairs(options?: KeyringOptions): TestKeyringMap

Defined in testingPairs.ts:14

Parameters:

Name Type
Optional options KeyringOptions

Returns: TestKeyringMap

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_testingpairs_.md b/docs/keyring/modules/_testingpairs_.md index a95e34b7f..f16d9a919 100644 --- a/docs/keyring/modules/_testingpairs_.md +++ b/docs/keyring/modules/_testingpairs_.md @@ -8,7 +8,7 @@ ▸ **testKeyringPairs**(options?: *[KeyringOptions](_types_.md#keyringoptions)*): `TestKeyringMap` -*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/testingPairs.ts#L14)* +*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/testingPairs.ts#L14)* **Parameters:** diff --git a/docs/keyring/modules/_types_.html b/docs/keyring/modules/_types_.html index c0ce7f1ae..ad078962f 100644 --- a/docs/keyring/modules/_types_.html +++ b/docs/keyring/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

KeyringOptions

Ƭ KeyringOptions: object

Defined in types.ts:9

Type declaration

KeyringPair$Json

Ƭ KeyringPair$Json: object

Defined in types.ts:26

Type declaration

KeyringPair$JsonEncoding

Ƭ KeyringPair$JsonEncoding: object

Defined in types.ts:20

Type declaration

KeyringPair$JsonVersion

Ƭ KeyringPair$JsonVersion: "0" | "1"

Defined in types.ts:18

KeyringPair$Meta

Ƭ KeyringPair$Meta: object

Defined in types.ts:14

Type declaration

KeyringPairType

Ƭ KeyringPairType: "ed25519" | "sr25519"

Defined in types.ts:7

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

KeyringOptions

Ƭ KeyringOptions: object

Defined in types.ts:9

Type declaration

KeyringPair$Json

Ƭ KeyringPair$Json: object

Defined in types.ts:26

Type declaration

KeyringPair$JsonEncoding

Ƭ KeyringPair$JsonEncoding: object

Defined in types.ts:20

Type declaration

KeyringPair$JsonVersion

Ƭ KeyringPair$JsonVersion: "0" | "1"

Defined in types.ts:18

KeyringPair$Meta

Ƭ KeyringPair$Meta: object

Defined in types.ts:14

Type declaration

KeyringPairType

Ƭ KeyringPairType: "ed25519" | "sr25519"

Defined in types.ts:7

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/keyring/modules/_types_.md b/docs/keyring/modules/_types_.md index 7b59a8928..1b1f4ae49 100644 --- a/docs/keyring/modules/_types_.md +++ b/docs/keyring/modules/_types_.md @@ -27,7 +27,7 @@ **Ƭ KeyringOptions**: *`object`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L9)* #### Type declaration @@ -38,7 +38,7 @@ ___ **Ƭ KeyringPair$Json**: *`object`* -*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L26)* #### Type declaration @@ -49,7 +49,7 @@ ___ **Ƭ KeyringPair$JsonEncoding**: *`object`* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L20)* #### Type declaration @@ -60,7 +60,7 @@ ___ **Ƭ KeyringPair$JsonVersion**: *"0" \| "1"* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L18)* ___ @@ -69,7 +69,7 @@ ___ **Ƭ KeyringPair$Meta**: *`object`* -*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L14)* #### Type declaration @@ -82,7 +82,7 @@ ___ **Ƭ KeyringPairType**: *"ed25519" \| "sr25519"* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/keyring/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/keyring/src/types.ts#L7)* ___ diff --git a/docs/trie-codec/SUMMARY.html b/docs/trie-codec/SUMMARY.html index ac5ff0cef..c613b4638 100644 --- a/docs/trie-codec/SUMMARY.html +++ b/docs/trie-codec/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.branchheader.html b/docs/trie-codec/classes/_nodeheader_.branchheader.html index f5236a75d..fd900a2c6 100644 --- a/docs/trie-codec/classes/_nodeheader_.branchheader.html +++ b/docs/trie-codec/classes/_nodeheader_.branchheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Boolean

↳ BranchHeader

Properties

<Static> Boolean

● Boolean: BooleanConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540

Methods

valueOf

▸ valueOf(): boolean

Inherited from Boolean.valueOf

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531

Returns the primitive value of the specified object.

Returns: boolean

Last Updated: 2/15/2019, 1:40:51 PM
- +

Hierarchy

Boolean

↳ BranchHeader

Properties

<Static> Boolean

● Boolean: BooleanConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540

Methods

valueOf

▸ valueOf(): boolean

Inherited from Boolean.valueOf

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531

Returns the primitive value of the specified object.

Returns: boolean

Last Updated: 2/15/2019, 1:40:51 PM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.extensionheader.html b/docs/trie-codec/classes/_nodeheader_.extensionheader.html index 81c615d12..02702ab38 100644 --- a/docs/trie-codec/classes/_nodeheader_.extensionheader.html +++ b/docs/trie-codec/classes/_nodeheader_.extensionheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ ExtensionHeader

Constructors

constructor

⊕ new ExtensionHeader(input: number): ExtensionHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: ExtensionHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ ExtensionHeader

Constructors

constructor

⊕ new ExtensionHeader(input: number): ExtensionHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: ExtensionHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.extensionheader.md b/docs/trie-codec/classes/_nodeheader_.extensionheader.md index ad1d37506..1c0995ae9 100644 --- a/docs/trie-codec/classes/_nodeheader_.extensionheader.md +++ b/docs/trie-codec/classes/_nodeheader_.extensionheader.md @@ -16,7 +16,7 @@ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)* -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)* -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.leafheader.html b/docs/trie-codec/classes/_nodeheader_.leafheader.html index 1b2cd9dab..20ccedd4d 100644 --- a/docs/trie-codec/classes/_nodeheader_.leafheader.html +++ b/docs/trie-codec/classes/_nodeheader_.leafheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ LeafHeader

Constructors

constructor

⊕ new LeafHeader(input: number): LeafHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: LeafHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ LeafHeader

Constructors

constructor

⊕ new LeafHeader(input: number): LeafHeader

Inherited from NibbleHeader.constructor

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: LeafHeader

Methods

toNumber

▸ toNumber(): number

Inherited from NibbleHeader.toNumber

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.leafheader.md b/docs/trie-codec/classes/_nodeheader_.leafheader.md index a41c30b23..a8a20dec8 100644 --- a/docs/trie-codec/classes/_nodeheader_.leafheader.md +++ b/docs/trie-codec/classes/_nodeheader_.leafheader.md @@ -16,7 +16,7 @@ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)* -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)* -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.nibbleheader.html b/docs/trie-codec/classes/_nodeheader_.nibbleheader.html index da7701c44..3b037ee5e 100644 --- a/docs/trie-codec/classes/_nodeheader_.nibbleheader.html +++ b/docs/trie-codec/classes/_nodeheader_.nibbleheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NibbleHeader

↳ ExtensionHeader

↳ LeafHeader

Constructors

constructor

⊕ new NibbleHeader(input: number): NibbleHeader

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: NibbleHeader

Methods

toNumber

▸ toNumber(): number

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NibbleHeader

↳ ExtensionHeader

↳ LeafHeader

Constructors

constructor

⊕ new NibbleHeader(input: number): NibbleHeader

Defined in NodeHeader.ts:21

Parameters:

Name Type
input number

Returns: NibbleHeader

Methods

toNumber

▸ toNumber(): number

Defined in NodeHeader.ts:27

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.nibbleheader.md b/docs/trie-codec/classes/_nodeheader_.nibbleheader.md index 36c67c13c..bdfadc270 100644 --- a/docs/trie-codec/classes/_nodeheader_.nibbleheader.md +++ b/docs/trie-codec/classes/_nodeheader_.nibbleheader.md @@ -16,7 +16,7 @@ ⊕ **new NibbleHeader**(input: *`number`*): [NibbleHeader](_nodeheader_.nibbleheader.md) -*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* **Parameters:** @@ -36,7 +36,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* **Returns:** `number` diff --git a/docs/trie-codec/classes/_nodeheader_.nodeheader.html b/docs/trie-codec/classes/_nodeheader_.nodeheader.html index 778d3f9dd..d2e76668a 100644 --- a/docs/trie-codec/classes/_nodeheader_.nodeheader.html +++ b/docs/trie-codec/classes/_nodeheader_.nodeheader.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

NodeHeader

Constructors

constructor

⊕ new NodeHeader(input?: null | Uint8Array | Array<null | Uint8Array>): NodeHeader

Defined in NodeHeader.ts:40

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: NodeHeader

Accessors

encodedLength

get encodedLength(): number

Defined in NodeHeader.ts:92

Returns: number

nodeType

get nodeType(): number

Defined in NodeHeader.ts:114

Returns: number

value

get value(): Null | BranchHeader | ExtensionHeader | LeafHeader

Defined in NodeHeader.ts:118

Returns: Null | BranchHeader | ExtensionHeader | LeafHeader

Methods

toU8a

▸ toU8a(): Uint8Array

Defined in NodeHeader.ts:122

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

NodeHeader

Constructors

constructor

⊕ new NodeHeader(input?: null | Uint8Array | Array<null | Uint8Array>): NodeHeader

Defined in NodeHeader.ts:40

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: NodeHeader

Accessors

encodedLength

get encodedLength(): number

Defined in NodeHeader.ts:92

Returns: number

nodeType

get nodeType(): number

Defined in NodeHeader.ts:114

Returns: number

value

get value(): Null | BranchHeader | ExtensionHeader | LeafHeader

Defined in NodeHeader.ts:118

Returns: Null | BranchHeader | ExtensionHeader | LeafHeader

Methods

toU8a

▸ toU8a(): Uint8Array

Defined in NodeHeader.ts:122

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.nodeheader.md b/docs/trie-codec/classes/_nodeheader_.nodeheader.md index 8380c2353..114eb13ea 100644 --- a/docs/trie-codec/classes/_nodeheader_.nodeheader.md +++ b/docs/trie-codec/classes/_nodeheader_.nodeheader.md @@ -12,7 +12,7 @@ ⊕ **new NodeHeader**(input?: *`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md) -*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L40)* +*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L40)* **Parameters:** @@ -32,7 +32,7 @@ ___ **get encodedLength**(): `number` -*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L92)* +*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L92)* **Returns:** `number` @@ -43,7 +43,7 @@ ___ **get nodeType**(): `number` -*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L114)* +*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L114)* **Returns:** `number` @@ -54,7 +54,7 @@ ___ **get value**(): [Null](_nodeheader_.null.md) \| [BranchHeader](_nodeheader_.branchheader.md) \| [ExtensionHeader](_nodeheader_.extensionheader.md) \| [LeafHeader](_nodeheader_.leafheader.md) -*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L118)* +*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L118)* **Returns:** [Null](_nodeheader_.null.md) \| [BranchHeader](_nodeheader_.branchheader.md) \| [ExtensionHeader](_nodeheader_.extensionheader.md) \| [LeafHeader](_nodeheader_.leafheader.md) @@ -68,7 +68,7 @@ ___ ▸ **toU8a**(): `Uint8Array` -*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/NodeHeader.ts#L122)* +*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/NodeHeader.ts#L122)* **Returns:** `Uint8Array` diff --git a/docs/trie-codec/classes/_nodeheader_.null.html b/docs/trie-codec/classes/_nodeheader_.null.html index 2f10de7eb..c462401b4 100644 --- a/docs/trie-codec/classes/_nodeheader_.null.html +++ b/docs/trie-codec/classes/_nodeheader_.null.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Null

Last Updated: 2/13/2019, 4:33:49 PM
- +

Hierarchy

Null

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-codec/index.html b/docs/trie-codec/index.html index dba5674cb..97a954de3 100644 --- a/docs/trie-codec/index.html +++ b/docs/trie-codec/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/trie-codec

Implementation of the Substrate-specific codec for a Trie

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/trie-codec

Implementation of the Substrate-specific codec for a Trie

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/trie-codec/modules/_constants_.html b/docs/trie-codec/modules/_constants_.html index a767f64f1..365f33ee6 100644 --- a/docs/trie-codec/modules/_constants_.html +++ b/docs/trie-codec/modules/_constants_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Variables

<Const> BRANCH_NODE_NO_VALUE

● BRANCH_NODE_NO_VALUE: 254 = 254

Defined in constants.ts:10

<Const> BRANCH_NODE_WITH_VALUE

● BRANCH_NODE_WITH_VALUE: 255 = 255

Defined in constants.ts:11

<Const> EMPTY_TRIE

● EMPTY_TRIE: 0 = 0

Defined in constants.ts:5

<Const> EXTENSION_NODE_BIG

● EXTENSION_NODE_BIG: 253 = 253

Defined in constants.ts:9

<Const> EXTENSION_NODE_OFFSET

● EXTENSION_NODE_OFFSET: 128 = 128

Defined in constants.ts:8

<Const> EXTENSION_NODE_SMALL_MAX

● EXTENSION_NODE_SMALL_MAX: number = EXTENSION_NODE_BIG - 1

Defined in constants.ts:15

<Const> EXTENSION_NODE_THRESHOLD

● EXTENSION_NODE_THRESHOLD: number = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET

Defined in constants.ts:13

<Const> LEAF_NODE_BIG

● LEAF_NODE_BIG: 127 = 127

Defined in constants.ts:7

<Const> LEAF_NODE_OFFSET

● LEAF_NODE_OFFSET: 1 = 1

Defined in constants.ts:6

<Const> LEAF_NODE_SMALL_MAX

● LEAF_NODE_SMALL_MAX: number = LEAF_NODE_BIG - 1

Defined in constants.ts:14

<Const> LEAF_NODE_THRESHOLD

● LEAF_NODE_THRESHOLD: number = LEAF_NODE_BIG - LEAF_NODE_OFFSET

Defined in constants.ts:12

<Const> NODE_TYPE_BRANCH

● NODE_TYPE_BRANCH: 1 = 1

Defined in constants.ts:17

<Const> NODE_TYPE_EXT

● NODE_TYPE_EXT: 2 = 2

Defined in constants.ts:18

<Const> NODE_TYPE_LEAF

● NODE_TYPE_LEAF: 3 = 3

Defined in constants.ts:19

<Const> NODE_TYPE_NULL

● NODE_TYPE_NULL: 0 = 0

Defined in constants.ts:16

Last Updated: 2/26/2019, 11:08:42 AM
- +

Variables

<Const> BRANCH_NODE_NO_VALUE

● BRANCH_NODE_NO_VALUE: 254 = 254

Defined in constants.ts:10

<Const> BRANCH_NODE_WITH_VALUE

● BRANCH_NODE_WITH_VALUE: 255 = 255

Defined in constants.ts:11

<Const> EMPTY_TRIE

● EMPTY_TRIE: 0 = 0

Defined in constants.ts:5

<Const> EXTENSION_NODE_BIG

● EXTENSION_NODE_BIG: 253 = 253

Defined in constants.ts:9

<Const> EXTENSION_NODE_OFFSET

● EXTENSION_NODE_OFFSET: 128 = 128

Defined in constants.ts:8

<Const> EXTENSION_NODE_SMALL_MAX

● EXTENSION_NODE_SMALL_MAX: number = EXTENSION_NODE_BIG - 1

Defined in constants.ts:15

<Const> EXTENSION_NODE_THRESHOLD

● EXTENSION_NODE_THRESHOLD: number = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET

Defined in constants.ts:13

<Const> LEAF_NODE_BIG

● LEAF_NODE_BIG: 127 = 127

Defined in constants.ts:7

<Const> LEAF_NODE_OFFSET

● LEAF_NODE_OFFSET: 1 = 1

Defined in constants.ts:6

<Const> LEAF_NODE_SMALL_MAX

● LEAF_NODE_SMALL_MAX: number = LEAF_NODE_BIG - 1

Defined in constants.ts:14

<Const> LEAF_NODE_THRESHOLD

● LEAF_NODE_THRESHOLD: number = LEAF_NODE_BIG - LEAF_NODE_OFFSET

Defined in constants.ts:12

<Const> NODE_TYPE_BRANCH

● NODE_TYPE_BRANCH: 1 = 1

Defined in constants.ts:17

<Const> NODE_TYPE_EXT

● NODE_TYPE_EXT: 2 = 2

Defined in constants.ts:18

<Const> NODE_TYPE_LEAF

● NODE_TYPE_LEAF: 3 = 3

Defined in constants.ts:19

<Const> NODE_TYPE_NULL

● NODE_TYPE_NULL: 0 = 0

Defined in constants.ts:16

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_constants_.md b/docs/trie-codec/modules/_constants_.md index 472967b0e..5cfcdc209 100644 --- a/docs/trie-codec/modules/_constants_.md +++ b/docs/trie-codec/modules/_constants_.md @@ -8,7 +8,7 @@ **● BRANCH_NODE_NO_VALUE**: *`254`* = 254 -*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L10)* +*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L10)* ___ @@ -17,7 +17,7 @@ ___ **● BRANCH_NODE_WITH_VALUE**: *`255`* = 255 -*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L11)* +*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L11)* ___ @@ -26,7 +26,7 @@ ___ **● EMPTY_TRIE**: *`0`* = 0 -*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L5)* +*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L5)* ___ @@ -35,7 +35,7 @@ ___ **● EXTENSION_NODE_BIG**: *`253`* = 253 -*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L9)* ___ @@ -44,7 +44,7 @@ ___ **● EXTENSION_NODE_OFFSET**: *`128`* = 128 -*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L8)* +*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L8)* ___ @@ -53,7 +53,7 @@ ___ **● EXTENSION_NODE_SMALL_MAX**: *`number`* = EXTENSION_NODE_BIG - 1 -*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L15)* +*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L15)* ___ @@ -62,7 +62,7 @@ ___ **● EXTENSION_NODE_THRESHOLD**: *`number`* = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET -*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L13)* +*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L13)* ___ @@ -71,7 +71,7 @@ ___ **● LEAF_NODE_BIG**: *`127`* = 127 -*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L7)* +*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L7)* ___ @@ -80,7 +80,7 @@ ___ **● LEAF_NODE_OFFSET**: *`1`* = 1 -*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L6)* +*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L6)* ___ @@ -89,7 +89,7 @@ ___ **● LEAF_NODE_SMALL_MAX**: *`number`* = LEAF_NODE_BIG - 1 -*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L14)* ___ @@ -98,7 +98,7 @@ ___ **● LEAF_NODE_THRESHOLD**: *`number`* = LEAF_NODE_BIG - LEAF_NODE_OFFSET -*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L12)* +*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L12)* ___ @@ -107,7 +107,7 @@ ___ **● NODE_TYPE_BRANCH**: *`1`* = 1 -*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L17)* +*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L17)* ___ @@ -116,7 +116,7 @@ ___ **● NODE_TYPE_EXT**: *`2`* = 2 -*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L18)* +*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L18)* ___ @@ -125,7 +125,7 @@ ___ **● NODE_TYPE_LEAF**: *`3`* = 3 -*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L19)* +*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L19)* ___ @@ -134,7 +134,7 @@ ___ **● NODE_TYPE_NULL**: *`0`* = 0 -*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/constants.ts#L16)* +*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/constants.ts#L16)* ___ diff --git a/docs/trie-codec/modules/_decode_.html b/docs/trie-codec/modules/_decode_.html index d83c03cb0..cf53cdfbd 100644 --- a/docs/trie-codec/modules/_decode_.html +++ b/docs/trie-codec/modules/_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(input: null | Uint8Array): Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Defined in decode.ts:95

Parameters:

Name Type
input null | Uint8Array

Returns: Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(input: null | Uint8Array): Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Defined in decode.ts:95

Parameters:

Name Type
input null | Uint8Array

Returns: Uint8Array | null | Array<null | Uint8Array | Array<null | Uint8Array>>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_decode_.md b/docs/trie-codec/modules/_decode_.md index 60e22f11a..9c4140c35 100644 --- a/docs/trie-codec/modules/_decode_.md +++ b/docs/trie-codec/modules/_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(input: *`null` \| `Uint8Array`*): `Uint8Array` \| `null` \| `Array`<`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>> -*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/decode.ts#L95)* +*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/decode.ts#L95)* **Parameters:** diff --git a/docs/trie-codec/modules/_encode_.html b/docs/trie-codec/modules/_encode_.html index 081db8e1e..41187d785 100644 --- a/docs/trie-codec/modules/_encode_.html +++ b/docs/trie-codec/modules/_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encode

▸ encode(input?: null | Uint8Array | Array<null | Uint8Array>): Uint8Array

Defined in encode.ts:101

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encode

▸ encode(input?: null | Uint8Array | Array<null | Uint8Array>): Uint8Array

Defined in encode.ts:101

Parameters:

Name Type
Optional input null | Uint8Array | Array<null | Uint8Array>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_encode_.md b/docs/trie-codec/modules/_encode_.md index d46f53513..7efc3cc4b 100644 --- a/docs/trie-codec/modules/_encode_.md +++ b/docs/trie-codec/modules/_encode_.md @@ -8,7 +8,7 @@ ▸ **encode**(input?: *`null` \| `Uint8Array` \| `Array`<`null` \| `Uint8Array`>*): `Uint8Array` -*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/encode.ts#L101)* +*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/encode.ts#L101)* **Parameters:** diff --git a/docs/trie-codec/modules/_hashing_.html b/docs/trie-codec/modules/_hashing_.html index 266efb168..15b39d8b0 100644 --- a/docs/trie-codec/modules/_hashing_.html +++ b/docs/trie-codec/modules/_hashing_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-codec/modules/_nibbles_.html b/docs/trie-codec/modules/_nibbles_.html index 6fd017e37..2ed61392b 100644 --- a/docs/trie-codec/modules/_nibbles_.html +++ b/docs/trie-codec/modules/_nibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

addNibblesTerminator

▸ addNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:31

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

decodeNibbles

▸ decodeNibbles(value: null | Uint8Array): Uint8Array

Defined in nibbles.ts:52

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

encodeNibbles

▸ encodeNibbles(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:65

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

extractKey

▸ extractKey(key: null | Uint8Array): Uint8Array

Defined in nibbles.ts:15

Parameters:

Name Type
key null | Uint8Array

Returns: Uint8Array

extractNodeKey

▸ extractNodeKey(__namedParameters: [null | Uint8Array]): Uint8Array

Defined in nibbles.ts:21

Parameters:

Name Type
__namedParameters [null | Uint8Array]

Returns: Uint8Array

isNibblesTerminated

▸ isNibblesTerminated(nibbles: Uint8Array): boolean

Defined in nibbles.ts:27

Parameters:

Name Type
nibbles Uint8Array

Returns: boolean

removeNibblesTerminator

▸ removeNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:44

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

addNibblesTerminator

▸ addNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:31

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

decodeNibbles

▸ decodeNibbles(value: null | Uint8Array): Uint8Array

Defined in nibbles.ts:52

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

encodeNibbles

▸ encodeNibbles(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:65

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

extractKey

▸ extractKey(key: null | Uint8Array): Uint8Array

Defined in nibbles.ts:15

Parameters:

Name Type
key null | Uint8Array

Returns: Uint8Array

extractNodeKey

▸ extractNodeKey(__namedParameters: [null | Uint8Array]): Uint8Array

Defined in nibbles.ts:21

Parameters:

Name Type
__namedParameters [null | Uint8Array]

Returns: Uint8Array

isNibblesTerminated

▸ isNibblesTerminated(nibbles: Uint8Array): boolean

Defined in nibbles.ts:27

Parameters:

Name Type
nibbles Uint8Array

Returns: boolean

removeNibblesTerminator

▸ removeNibblesTerminator(nibbles: Uint8Array): Uint8Array

Defined in nibbles.ts:44

Parameters:

Name Type
nibbles Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_nibbles_.md b/docs/trie-codec/modules/_nibbles_.md index 3f52636a5..5ac60ed32 100644 --- a/docs/trie-codec/modules/_nibbles_.md +++ b/docs/trie-codec/modules/_nibbles_.md @@ -8,7 +8,7 @@ ▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L31)* +*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L31)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **decodeNibbles**(value: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L52)* +*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L52)* **Parameters:** @@ -42,7 +42,7 @@ ___ ▸ **encodeNibbles**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L65)* +*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L65)* **Parameters:** @@ -59,7 +59,7 @@ ___ ▸ **extractKey**(key: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L15)* +*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L15)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **extractNodeKey**(__namedParameters: *[`null` \| `Uint8Array`]*): `Uint8Array` -*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L21)* +*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L21)* **Parameters:** @@ -93,7 +93,7 @@ ___ ▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean` -*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L27)* +*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L27)* **Parameters:** @@ -110,7 +110,7 @@ ___ ▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array` -*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/nibbles.ts#L44)* +*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/nibbles.ts#L44)* **Parameters:** diff --git a/docs/trie-codec/modules/_nodeheader_.html b/docs/trie-codec/modules/_nodeheader_.html index 0c7d34c6c..8c77c226e 100644 --- a/docs/trie-codec/modules/_nodeheader_.html +++ b/docs/trie-codec/modules/_nodeheader_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-codec/modules/_stream_createbranch_.html b/docs/trie-codec/modules/_stream_createbranch_.html index bfd428c5a..3be9a5dc2 100644 --- a/docs/trie-codec/modules/_stream_createbranch_.html +++ b/docs/trie-codec/modules/_stream_createbranch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createBranch

▸ createBranch(value: Uint8Array | null, hasChildren: Array<boolean>): Uint8Array

Defined in stream/createBranch.ts:10

Parameters:

Name Type
value Uint8Array | null
hasChildren Array<boolean>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createBranch

▸ createBranch(value: Uint8Array | null, hasChildren: Array<boolean>): Uint8Array

Defined in stream/createBranch.ts:10

Parameters:

Name Type
value Uint8Array | null
hasChildren Array<boolean>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createbranch_.md b/docs/trie-codec/modules/_stream_createbranch_.md index f3c3d672e..1820e4f9e 100644 --- a/docs/trie-codec/modules/_stream_createbranch_.md +++ b/docs/trie-codec/modules/_stream_createbranch_.md @@ -8,7 +8,7 @@ ▸ **createBranch**(value: *`Uint8Array` \| `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array` -*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createBranch.ts#L10)* +*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createBranch.ts#L10)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createempty_.html b/docs/trie-codec/modules/_stream_createempty_.html index 870f583e8..bd68372d5 100644 --- a/docs/trie-codec/modules/_stream_createempty_.html +++ b/docs/trie-codec/modules/_stream_createempty_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createEmpty

▸ createEmpty(): Uint8Array

Defined in stream/createEmpty.ts:7

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createEmpty

▸ createEmpty(): Uint8Array

Defined in stream/createEmpty.ts:7

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createempty_.md b/docs/trie-codec/modules/_stream_createempty_.md index fb4e3f86c..091214670 100644 --- a/docs/trie-codec/modules/_stream_createempty_.md +++ b/docs/trie-codec/modules/_stream_createempty_.md @@ -8,7 +8,7 @@ ▸ **createEmpty**(): `Uint8Array` -*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createEmpty.ts#L7)* +*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createEmpty.ts#L7)* **Returns:** `Uint8Array` diff --git a/docs/trie-codec/modules/_stream_createextension_.html b/docs/trie-codec/modules/_stream_createextension_.html index 6a9e0f240..26f7b48b0 100644 --- a/docs/trie-codec/modules/_stream_createextension_.html +++ b/docs/trie-codec/modules/_stream_createextension_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createExtension

▸ createExtension(key: Uint8Array): Uint8Array

Defined in stream/createExtension.ts:7

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createExtension

▸ createExtension(key: Uint8Array): Uint8Array

Defined in stream/createExtension.ts:7

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createextension_.md b/docs/trie-codec/modules/_stream_createextension_.md index 2cd238c0d..c813710ae 100644 --- a/docs/trie-codec/modules/_stream_createextension_.md +++ b/docs/trie-codec/modules/_stream_createextension_.md @@ -8,7 +8,7 @@ ▸ **createExtension**(key: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createExtension.ts#L7)* +*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createExtension.ts#L7)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createleaf_.html b/docs/trie-codec/modules/_stream_createleaf_.html index 037db9fe3..80701035a 100644 --- a/docs/trie-codec/modules/_stream_createleaf_.html +++ b/docs/trie-codec/modules/_stream_createleaf_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createLeaf

▸ createLeaf(key: Uint8Array, value: Uint8Array): Uint8Array

Defined in stream/createLeaf.ts:10

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createLeaf

▸ createLeaf(key: Uint8Array, value: Uint8Array): Uint8Array

Defined in stream/createLeaf.ts:10

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createleaf_.md b/docs/trie-codec/modules/_stream_createleaf_.md index a491cde44..da00f33b5 100644 --- a/docs/trie-codec/modules/_stream_createleaf_.md +++ b/docs/trie-codec/modules/_stream_createleaf_.md @@ -8,7 +8,7 @@ ▸ **createLeaf**(key: *`Uint8Array`*, value: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createLeaf.ts#L10)* +*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createLeaf.ts#L10)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createsubstream_.html b/docs/trie-codec/modules/_stream_createsubstream_.html index e251e2c54..c2be695d9 100644 --- a/docs/trie-codec/modules/_stream_createsubstream_.html +++ b/docs/trie-codec/modules/_stream_createsubstream_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createSubstream

▸ createSubstream(value: Uint8Array): Uint8Array

Defined in stream/createSubstream.ts:8

Parameters:

Name Type
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createSubstream

▸ createSubstream(value: Uint8Array): Uint8Array

Defined in stream/createSubstream.ts:8

Parameters:

Name Type
value Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createsubstream_.md b/docs/trie-codec/modules/_stream_createsubstream_.md index 02c877b3f..77a14d6e3 100644 --- a/docs/trie-codec/modules/_stream_createsubstream_.md +++ b/docs/trie-codec/modules/_stream_createsubstream_.md @@ -8,7 +8,7 @@ ▸ **createSubstream**(value: *`Uint8Array`*): `Uint8Array` -*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createSubstream.ts#L8)* +*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createSubstream.ts#L8)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_createvalue_.html b/docs/trie-codec/modules/_stream_createvalue_.html index 0c1a89bff..82ff6d5c5 100644 --- a/docs/trie-codec/modules/_stream_createvalue_.html +++ b/docs/trie-codec/modules/_stream_createvalue_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

createValue

▸ createValue(value: null | Uint8Array): Uint8Array

Defined in stream/createValue.ts:9

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

createValue

▸ createValue(value: null | Uint8Array): Uint8Array

Defined in stream/createValue.ts:9

Parameters:

Name Type
value null | Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_createvalue_.md b/docs/trie-codec/modules/_stream_createvalue_.md index 00f85b863..bc95913b6 100644 --- a/docs/trie-codec/modules/_stream_createvalue_.md +++ b/docs/trie-codec/modules/_stream_createvalue_.md @@ -8,7 +8,7 @@ ▸ **createValue**(value: *`null` \| `Uint8Array`*): `Uint8Array` -*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/createValue.ts#L9)* +*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/createValue.ts#L9)* **Parameters:** diff --git a/docs/trie-codec/modules/_stream_endbranch_.html b/docs/trie-codec/modules/_stream_endbranch_.html index 63ecc15f9..613e596d8 100644 --- a/docs/trie-codec/modules/_stream_endbranch_.html +++ b/docs/trie-codec/modules/_stream_endbranch_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encBranch

▸ encBranch(value: Uint8Array | null): Uint8Array

Defined in stream/endBranch.ts:7

Parameters:

Name Type
value Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encBranch

▸ encBranch(value: Uint8Array | null): Uint8Array

Defined in stream/endBranch.ts:7

Parameters:

Name Type
value Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_stream_endbranch_.md b/docs/trie-codec/modules/_stream_endbranch_.md index bd7ceae83..5de997bfb 100644 --- a/docs/trie-codec/modules/_stream_endbranch_.md +++ b/docs/trie-codec/modules/_stream_endbranch_.md @@ -8,7 +8,7 @@ ▸ **encBranch**(value: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/stream/endBranch.ts#L7)* +*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/stream/endBranch.ts#L7)* **Parameters:** diff --git a/docs/trie-codec/modules/_types_.html b/docs/trie-codec/modules/_types_.html index e44970363..c6897c688 100644 --- a/docs/trie-codec/modules/_types_.html +++ b/docs/trie-codec/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Codec

Ƭ Codec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Codec

Ƭ Codec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_types_.md b/docs/trie-codec/modules/_types_.md index 094217290..f093583be 100644 --- a/docs/trie-codec/modules/_types_.md +++ b/docs/trie-codec/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ Codec**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/types.ts#L5)* #### Type declaration diff --git a/docs/trie-codec/modules/_util_fromnibbles_.html b/docs/trie-codec/modules/_util_fromnibbles_.html index 932f41912..004ac5823 100644 --- a/docs/trie-codec/modules/_util_fromnibbles_.html +++ b/docs/trie-codec/modules/_util_fromnibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

fromNibbles

▸ fromNibbles(input: Uint8Array): Uint8Array

Defined in util/fromNibbles.ts:19

name: fromNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { fromNibbles } from '@polkadot/trie-codec/util';
+

Functions

fromNibbles

▸ fromNibbles(input: Uint8Array): Uint8Array

Defined in util/fromNibbles.ts:19

name: fromNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { fromNibbles } from '@polkadot/trie-codec/util';
 
 fromNibbles(new Uint8Array([4, 1, 2, 0])); // => Uint8Array([0x41, 0x20]
-
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_util_fromnibbles_.md b/docs/trie-codec/modules/_util_fromnibbles_.md index 9eea2f8ed..cc6fbe843 100644 --- a/docs/trie-codec/modules/_util_fromnibbles_.md +++ b/docs/trie-codec/modules/_util_fromnibbles_.md @@ -8,7 +8,7 @@ ▸ **fromNibbles**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/fromNibbles.ts#L19)* +*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fromNibbles.ts#L19)* *__name__*: fromNibbles diff --git a/docs/trie-codec/modules/_util_fusenibbles_.html b/docs/trie-codec/modules/_util_fusenibbles_.html index a8b5a84f8..e4c485b16 100644 --- a/docs/trie-codec/modules/_util_fusenibbles_.html +++ b/docs/trie-codec/modules/_util_fusenibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

fuseNibbles

▸ fuseNibbles(nibbles: Uint8Array, isLeaf: boolean): Uint8Array

Defined in util/fuseNibbles.ts:12

Parameters:

Name Type
nibbles Uint8Array
isLeaf boolean

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

fuseNibbles

▸ fuseNibbles(nibbles: Uint8Array, isLeaf: boolean): Uint8Array

Defined in util/fuseNibbles.ts:12

Parameters:

Name Type
nibbles Uint8Array
isLeaf boolean

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_util_fusenibbles_.md b/docs/trie-codec/modules/_util_fusenibbles_.md index 9a1050f81..e28c42dae 100644 --- a/docs/trie-codec/modules/_util_fusenibbles_.md +++ b/docs/trie-codec/modules/_util_fusenibbles_.md @@ -8,7 +8,7 @@ ▸ **fuseNibbles**(nibbles: *`Uint8Array`*, isLeaf: *`boolean`*): `Uint8Array` -*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/fuseNibbles.ts#L12)* +*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/fuseNibbles.ts#L12)* **Parameters:** diff --git a/docs/trie-codec/modules/_util_sharedprefixlength_.html b/docs/trie-codec/modules/_util_sharedprefixlength_.html index 60ebc39e5..12c6cbbf3 100644 --- a/docs/trie-codec/modules/_util_sharedprefixlength_.html +++ b/docs/trie-codec/modules/_util_sharedprefixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

sharedPrefixLength

▸ sharedPrefixLength(first: Uint8Array, second: Uint8Array): number

Defined in util/sharedPrefixLength.ts:5

Parameters:

Name Type
first Uint8Array
second Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

sharedPrefixLength

▸ sharedPrefixLength(first: Uint8Array, second: Uint8Array): number

Defined in util/sharedPrefixLength.ts:5

Parameters:

Name Type
first Uint8Array
second Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_util_sharedprefixlength_.md b/docs/trie-codec/modules/_util_sharedprefixlength_.md index 7a11c54db..2750809cf 100644 --- a/docs/trie-codec/modules/_util_sharedprefixlength_.md +++ b/docs/trie-codec/modules/_util_sharedprefixlength_.md @@ -8,7 +8,7 @@ ▸ **sharedPrefixLength**(first: *`Uint8Array`*, second: *`Uint8Array`*): `number` -*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* +*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* **Parameters:** diff --git a/docs/trie-codec/modules/_util_tonibbles_.html b/docs/trie-codec/modules/_util_tonibbles_.html index e496d546a..4bafc7ace 100644 --- a/docs/trie-codec/modules/_util_tonibbles_.html +++ b/docs/trie-codec/modules/_util_tonibbles_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

toNibbles

▸ toNibbles(input?: Uint8Array | null): Uint8Array

Defined in util/toNibbles.ts:19

name: toNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { toNibbles } from '@polkadot/trie-codec/util';
+

Functions

toNibbles

▸ toNibbles(input?: Uint8Array | null): Uint8Array

Defined in util/toNibbles.ts:19

name: toNibbles

summary: Converts the input to Nibbles.

description: From an Uint8Array input, calculate and return a list of nibbles that makes up the input.

example:

import { toNibbles } from '@polkadot/trie-codec/util';
 
 toNibbles(new Uint8Array([0x41, 0x20]); // => Uint8Array([4, 1, 2, 0])
-
1
2
3

Parameters:

Name Type
Optional input Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional input Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-codec/modules/_util_tonibbles_.md b/docs/trie-codec/modules/_util_tonibbles_.md index a705cb725..8eb42c5a9 100644 --- a/docs/trie-codec/modules/_util_tonibbles_.md +++ b/docs/trie-codec/modules/_util_tonibbles_.md @@ -8,7 +8,7 @@ ▸ **toNibbles**(input?: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-codec/src/util/toNibbles.ts#L19)* +*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-codec/src/util/toNibbles.ts#L19)* *__name__*: toNibbles diff --git a/docs/trie-db/SUMMARY.html b/docs/trie-db/SUMMARY.html index f80371413..2eee7dbac 100644 --- a/docs/trie-db/SUMMARY.html +++ b/docs/trie-db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/trie-db/classes/_checkpoint_.checkpoint.html b/docs/trie-db/classes/_checkpoint_.checkpoint.html index 81650c8b1..647659436 100644 --- a/docs/trie-db/classes/_checkpoint_.checkpoint.html +++ b/docs/trie-db/classes/_checkpoint_.checkpoint.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Checkpoint(rootHash: Uint8Array): Checkpoint

Defined in Checkpoint.ts:7

Parameters:

Name Type
rootHash Uint8Array

Returns: Checkpoint

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Checkpoint(rootHash: Uint8Array): Checkpoint

Defined in Checkpoint.ts:7

Parameters:

Name Type
rootHash Uint8Array

Returns: Checkpoint

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/classes/_checkpoint_.checkpoint.md b/docs/trie-db/classes/_checkpoint_.checkpoint.md index 6e0f4478e..ac8633792 100644 --- a/docs/trie-db/classes/_checkpoint_.checkpoint.md +++ b/docs/trie-db/classes/_checkpoint_.checkpoint.md @@ -14,7 +14,7 @@ ⊕ **new Checkpoint**(rootHash: *`Uint8Array`*): [Checkpoint](_checkpoint_.checkpoint.md) -*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Checkpoint.ts#L7)* +*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Checkpoint.ts#L7)* **Parameters:** diff --git a/docs/trie-db/classes/_impl_.impl.html b/docs/trie-db/classes/_impl_.impl.html index c9ac1780b..5526ec6f2 100644 --- a/docs/trie-db/classes/_impl_.impl.html +++ b/docs/trie-db/classes/_impl_.impl.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

@polkadot/trie-db

Overview

name: Trie

summary: Re-implementation of a Patricia Trie

example: See Polkadot-JS Common Trie-DB Examples

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Impl(db: TxDb, rootHash?: Uint8Array, codec?: Codec): Impl

Overrides Checkpoint.constructor

Defined in Impl.ts:38

Parameters:

Name Type Default value
db TxDb -
Optional rootHash Uint8Array -
Default value codec Codec substrateCodec

Returns: Impl

Properties

db

● db: TxDb

Defined in Impl.ts:36

Last Updated: 2/26/2019, 11:08:42 AM
- +

@polkadot/trie-db

Overview

name: Trie

summary: Re-implementation of a Patricia Trie

example: See Polkadot-JS Common Trie-DB Examples

Hierarchy

Checkpoint

↳ Impl

Constructors

constructor

⊕ new Impl(db: TxDb, rootHash?: Uint8Array, codec?: Codec): Impl

Overrides Checkpoint.constructor

Defined in Impl.ts:38

Parameters:

Name Type Default value
db TxDb -
Optional rootHash Uint8Array -
Default value codec Codec substrateCodec

Returns: Impl

Properties

db

● db: TxDb

Defined in Impl.ts:36

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/classes/_impl_.impl.md b/docs/trie-db/classes/_impl_.impl.md index c6c096e33..ba843b151 100644 --- a/docs/trie-db/classes/_impl_.impl.md +++ b/docs/trie-db/classes/_impl_.impl.md @@ -28,7 +28,7 @@ Overview *Overrides [Checkpoint](_checkpoint_.checkpoint.md).[constructor](_checkpoint_.checkpoint.md#constructor)* -*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Impl.ts#L38)* +*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L38)* **Parameters:** @@ -50,7 +50,7 @@ ___ **● db**: *`TxDb`* -*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/Impl.ts#L36)* ___ diff --git a/docs/trie-db/enums/_types_.nodetype.html b/docs/trie-db/enums/_types_.nodetype.html index dffac3b0d..2f3f6138d 100644 --- a/docs/trie-db/enums/_types_.nodetype.html +++ b/docs/trie-db/enums/_types_.nodetype.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 3

Defined in types.ts:11

EMPTY

EMPTY: = 0

Defined in types.ts:8

EXTENSION

EXTENSION: = 2

Defined in types.ts:10

LEAF

LEAF: = 1

Defined in types.ts:9

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumeration members

Enumeration members

BRANCH

BRANCH: = 3

Defined in types.ts:11

EMPTY

EMPTY: = 0

Defined in types.ts:8

EXTENSION

EXTENSION: = 2

Defined in types.ts:10

LEAF

LEAF: = 1

Defined in types.ts:9

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/enums/_types_.nodetype.md b/docs/trie-db/enums/_types_.nodetype.md index c30300629..fc680f128 100644 --- a/docs/trie-db/enums/_types_.nodetype.md +++ b/docs/trie-db/enums/_types_.nodetype.md @@ -19,7 +19,7 @@ **BRANCH**: = 3 -*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L11)* ___ @@ -28,7 +28,7 @@ ___ **EMPTY**: = 0 -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L8)* ___ @@ -37,7 +37,7 @@ ___ **EXTENSION**: = 2 -*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L10)* ___ @@ -46,7 +46,7 @@ ___ **LEAF**: = 1 -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L9)* ___ diff --git a/docs/trie-db/index.html b/docs/trie-db/index.html index 8427c3d34..2a112d7b4 100644 --- a/docs/trie-db/index.html +++ b/docs/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

@polkadot/trie-db

A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.

This is a JavaScript port of the Python Ethereum Trie with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.

Usage

Installation -

yarn add @polkadot/trie-db
+

@polkadot/trie-db

A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.

This is a JavaScript port of the Python Ethereum Trie with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.

Usage

Installation -

yarn add @polkadot/trie-db
1

Classes can be imported as follows:

import Trie from '@polkadot/trie-db'; // Default export
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/trie-db/interfaces/_types_.triedb.html b/docs/trie-db/interfaces/_types_.triedb.html index 36bb8a286..2efc02697 100644 --- a/docs/trie-db/interfaces/_types_.triedb.html +++ b/docs/trie-db/interfaces/_types_.triedb.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

TxDb

↳ TrieDb

Properties

db

● db: TxDb

Defined in types.ts:37

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

getRoot

▸ getRoot(): Uint8Array

Defined in types.ts:39

Returns: Uint8Array

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

setRoot

▸ setRoot(rootHash: Uint8Array): void

Defined in types.ts:40

Parameters:

Name Type
rootHash Uint8Array

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:24

Returns: number

snapshot

▸ snapshot(dest: TrieDb, fn: ProgressCb): number

Defined in types.ts:41

Parameters:

Name Type
dest TrieDb
fn ProgressCb

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TxDb.transaction

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

TxDb

↳ TrieDb

Properties

db

● db: TxDb

Defined in types.ts:37

Methods

close

▸ close(): void

Inherited from BaseDb.close

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:18

Returns: void

del

▸ del(key: Uint8Array): void

Inherited from BaseDb.del

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:26

Parameters:

Name Type
key Uint8Array

Returns: void

drop

▸ drop(): void

Inherited from BaseDb.drop

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:20

Returns: void

empty

▸ empty(): void

Inherited from BaseDb.empty

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:21

Returns: void

get

▸ get(key: Uint8Array): Uint8Array | null

Inherited from BaseDb.get

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:27

Parameters:

Name Type
key Uint8Array

Returns: Uint8Array | null

getRoot

▸ getRoot(): Uint8Array

Defined in types.ts:39

Returns: Uint8Array

maintain

▸ maintain(fn: ProgressCb): void

Inherited from BaseDb.maintain

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:22

Parameters:

Name Type
fn ProgressCb

Returns: void

open

▸ open(): void

Inherited from BaseDb.open

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:19

Returns: void

put

▸ put(key: Uint8Array, value: Uint8Array): void

Inherited from BaseDb.put

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:28

Parameters:

Name Type
key Uint8Array
value Uint8Array

Returns: void

rename

▸ rename(base: string, file: string): void

Inherited from BaseDb.rename

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:23

Parameters:

Name Type
base string
file string

Returns: void

setRoot

▸ setRoot(rootHash: Uint8Array): void

Defined in types.ts:40

Parameters:

Name Type
rootHash Uint8Array

Returns: void

size

▸ size(): number

Inherited from BaseDb.size

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:24

Returns: number

snapshot

▸ snapshot(dest: TrieDb, fn: ProgressCb): number

Defined in types.ts:41

Parameters:

Name Type
dest TrieDb
fn ProgressCb

Returns: number

transaction

▸ transaction(fn: function): boolean

Inherited from TxDb.transaction

Defined in /home/travis/build/polkadot-js/common/packages/db/src/types.ts:32

Parameters:

Name Type
fn function

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/interfaces/_types_.triedb.md b/docs/trie-db/interfaces/_types_.triedb.md index f6b0a8318..9e091be93 100644 --- a/docs/trie-db/interfaces/_types_.triedb.md +++ b/docs/trie-db/interfaces/_types_.triedb.md @@ -14,7 +14,7 @@ **● db**: *`TxDb`* -*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L37)* ___ @@ -28,7 +28,7 @@ ___ *Inherited from BaseDb.close* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L18)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L18)* **Returns:** `void` @@ -41,7 +41,7 @@ ___ *Inherited from BaseDb.del* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L26)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L26)* **Parameters:** @@ -60,7 +60,7 @@ ___ *Inherited from BaseDb.drop* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L20)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L20)* **Returns:** `void` @@ -73,7 +73,7 @@ ___ *Inherited from BaseDb.empty* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L21)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L21)* **Returns:** `void` @@ -86,7 +86,7 @@ ___ *Inherited from BaseDb.get* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L27)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L27)* **Parameters:** @@ -103,7 +103,7 @@ ___ ▸ **getRoot**(): `Uint8Array` -*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L39)* **Returns:** `Uint8Array` @@ -116,7 +116,7 @@ ___ *Inherited from BaseDb.maintain* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L22)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L22)* **Parameters:** @@ -135,7 +135,7 @@ ___ *Inherited from BaseDb.open* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L19)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L19)* **Returns:** `void` @@ -148,7 +148,7 @@ ___ *Inherited from BaseDb.put* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L28)* **Parameters:** @@ -168,7 +168,7 @@ ___ *Inherited from BaseDb.rename* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L23)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L23)* **Parameters:** @@ -186,7 +186,7 @@ ___ ▸ **setRoot**(rootHash: *`Uint8Array`*): `void` -*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L40)* **Parameters:** @@ -205,7 +205,7 @@ ___ *Inherited from BaseDb.size* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L24)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L24)* **Returns:** `number` @@ -216,7 +216,7 @@ ___ ▸ **snapshot**(dest: *[TrieDb](_types_.triedb.md)*, fn: *`ProgressCb`*): `number` -*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L41)* **Parameters:** @@ -236,7 +236,7 @@ ___ *Inherited from TxDb.transaction* -*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/4b1681d/packages/db/src/types.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/815fdc7/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/trie-db/modules/_checkpoint_.html b/docs/trie-db/modules/_checkpoint_.html index 3b32c90df..237b16360 100644 --- a/docs/trie-db/modules/_checkpoint_.html +++ b/docs/trie-db/modules/_checkpoint_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-db/modules/_constants_.html b/docs/trie-db/modules/_constants_.html index 5f098b349..97df49e3c 100644 --- a/docs/trie-db/modules/_constants_.html +++ b/docs/trie-db/modules/_constants_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

Constants

Ƭ Constants: object

Defined in constants.ts:9

Type declaration

Functions

default

▸ default(codec: Codec): object

Defined in constants.ts:14

Parameters:

Name Type
codec Codec

Returns: object

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

Constants

Ƭ Constants: object

Defined in constants.ts:9

Type declaration

Functions

default

▸ default(codec: Codec): object

Defined in constants.ts:14

Parameters:

Name Type
codec Codec

Returns: object

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/modules/_constants_.md b/docs/trie-db/modules/_constants_.md index 59d6855c3..d3954f5b0 100644 --- a/docs/trie-db/modules/_constants_.md +++ b/docs/trie-db/modules/_constants_.md @@ -8,7 +8,7 @@ **Ƭ Constants**: *`object`* -*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L9)* #### Type declaration @@ -22,7 +22,7 @@ ___ ▸ **default**(codec: *`Codec`*): `object` -*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/constants.ts#L14)* **Parameters:** diff --git a/docs/trie-db/modules/_ethereumcodec_.html b/docs/trie-db/modules/_ethereumcodec_.html index 6cccd5a2a..48b661add 100644 --- a/docs/trie-db/modules/_ethereumcodec_.html +++ b/docs/trie-db/modules/_ethereumcodec_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-db/modules/_impl_.html b/docs/trie-db/modules/_impl_.html index d6b9fd748..4dbeb646b 100644 --- a/docs/trie-db/modules/_impl_.html +++ b/docs/trie-db/modules/_impl_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-db/modules/_types_.html b/docs/trie-db/modules/_types_.html index 613cff8c4..e35057f83 100644 --- a/docs/trie-db/modules/_types_.html +++ b/docs/trie-db/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Enumerations

Interfaces

Type aliases

Type aliases

EncodedPath

Ƭ EncodedPath: Uint8Array | null

Defined in types.ts:28

Node

Ƭ Node: NodeEmpty | NodeNotEmpty

Defined in types.ts:34

NodeBranch

Ƭ NodeBranch: [NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty]

Defined in types.ts:20

NodeEmpty

Ƭ NodeEmpty: null

Defined in types.ts:14

NodeEncoded

Ƭ NodeEncoded: Uint8Array

Defined in types.ts:16

NodeEncodedOrEmpty

Ƭ NodeEncodedOrEmpty: NodeEncoded | NodeEmpty

Defined in types.ts:18

NodeKv

Ƭ NodeKv: [EncodedPath, NodeEncodedOrEmpty]

Defined in types.ts:30

NodeNotEmpty

Ƭ NodeNotEmpty: NodeKv | NodeBranch

Defined in types.ts:32

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Enumerations

Interfaces

Type aliases

Type aliases

EncodedPath

Ƭ EncodedPath: Uint8Array | null

Defined in types.ts:28

Node

Ƭ Node: NodeEmpty | NodeNotEmpty

Defined in types.ts:34

NodeBranch

Ƭ NodeBranch: [NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty, NodeEncodedOrEmpty]

Defined in types.ts:20

NodeEmpty

Ƭ NodeEmpty: null

Defined in types.ts:14

NodeEncoded

Ƭ NodeEncoded: Uint8Array

Defined in types.ts:16

NodeEncodedOrEmpty

Ƭ NodeEncodedOrEmpty: NodeEncoded | NodeEmpty

Defined in types.ts:18

NodeKv

Ƭ NodeKv: [EncodedPath, NodeEncodedOrEmpty]

Defined in types.ts:30

NodeNotEmpty

Ƭ NodeNotEmpty: NodeKv | NodeBranch

Defined in types.ts:32

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/modules/_types_.md b/docs/trie-db/modules/_types_.md index b8ebd1300..75debb6b6 100644 --- a/docs/trie-db/modules/_types_.md +++ b/docs/trie-db/modules/_types_.md @@ -31,7 +31,7 @@ **Ƭ EncodedPath**: *`Uint8Array` \| `null`* -*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L28)* ___ @@ -40,7 +40,7 @@ ___ **Ƭ Node**: *[NodeEmpty](_types_.md#nodeempty) \| [NodeNotEmpty](_types_.md#nodenotempty)* -*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L34)* ___ @@ -49,7 +49,7 @@ ___ **Ƭ NodeBranch**: *[[NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]* -*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L20)* ___ @@ -58,7 +58,7 @@ ___ **Ƭ NodeEmpty**: *`null`* -*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L14)* ___ @@ -67,7 +67,7 @@ ___ **Ƭ NodeEncoded**: *`Uint8Array`* -*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L16)* ___ @@ -76,7 +76,7 @@ ___ **Ƭ NodeEncodedOrEmpty**: *[NodeEncoded](_types_.md#nodeencoded) \| [NodeEmpty](_types_.md#nodeempty)* -*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L18)* ___ @@ -85,7 +85,7 @@ ___ **Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]* -*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L30)* ___ @@ -94,7 +94,7 @@ ___ **Ƭ NodeNotEmpty**: *[NodeKv](_types_.md#nodekv) \| [NodeBranch](_types_.md#nodebranch)* -*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/types.ts#L32)* ___ diff --git a/docs/trie-db/modules/_util_is_.html b/docs/trie-db/modules/_util_is_.html index 9fd367035..f2c3f67c8 100644 --- a/docs/trie-db/modules/_util_is_.html +++ b/docs/trie-db/modules/_util_is_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

isBranchNode

▸ isBranchNode(node: Node): boolean

Defined in util/is.ts:52

name: isBranchNode

summary: Returns true if node is an Branch 17-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isEmptyNode

▸ isEmptyNode(node: Node): boolean

Defined in util/is.ts:16

name: isEmptyNode

summary: Returns true if node is NULL

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isExtensionNode

▸ isExtensionNode(node: Node): boolean

Defined in util/is.ts:34

name: isExtensionNode

summary: Returns true if node is an Extension 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isKvNode

▸ isKvNode(node: Node): boolean

Defined in util/is.ts:25

name: isKvNode

summary: Returns true if node is not empty and contains a single key/value pair

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isLeafNode

▸ isLeafNode(node: Node): boolean

Defined in util/is.ts:43

name: isLeafNode

summary: Returns true if node is an Leaf 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

isBranchNode

▸ isBranchNode(node: Node): boolean

Defined in util/is.ts:52

name: isBranchNode

summary: Returns true if node is an Branch 17-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isEmptyNode

▸ isEmptyNode(node: Node): boolean

Defined in util/is.ts:16

name: isEmptyNode

summary: Returns true if node is NULL

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isExtensionNode

▸ isExtensionNode(node: Node): boolean

Defined in util/is.ts:34

name: isExtensionNode

summary: Returns true if node is an Extension 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isKvNode

▸ isKvNode(node: Node): boolean

Defined in util/is.ts:25

name: isKvNode

summary: Returns true if node is not empty and contains a single key/value pair

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

isLeafNode

▸ isLeafNode(node: Node): boolean

Defined in util/is.ts:43

name: isLeafNode

summary: Returns true if node is an Leaf 2-item node

description: Refer to Merkle Patricia Trie specification

Parameters:

Name Type
node Node

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/modules/_util_is_.md b/docs/trie-db/modules/_util_is_.md index 10f2debd1..52657e5d7 100644 --- a/docs/trie-db/modules/_util_is_.md +++ b/docs/trie-db/modules/_util_is_.md @@ -8,7 +8,7 @@ ▸ **isBranchNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L52)* +*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L52)* *__name__*: isBranchNode @@ -31,7 +31,7 @@ ___ ▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L16)* +*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L16)* *__name__*: isEmptyNode @@ -54,7 +54,7 @@ ___ ▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L34)* +*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L34)* *__name__*: isExtensionNode @@ -77,7 +77,7 @@ ___ ▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L25)* +*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L25)* *__name__*: isKvNode @@ -100,7 +100,7 @@ ___ ▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean` -*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/is.ts#L43)* +*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/is.ts#L43)* *__name__*: isLeafNode diff --git a/docs/trie-db/modules/_util_key_.html b/docs/trie-db/modules/_util_key_.html index 0283a41bf..5117ca3e7 100644 --- a/docs/trie-db/modules/_util_key_.html +++ b/docs/trie-db/modules/_util_key_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

computeExtensionKey

▸ computeExtensionKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:36

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

computeLeafKey

▸ computeLeafKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:40

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

consumeCommonPrefix

▸ consumeCommonPrefix(left: Uint8Array, right: Uint8Array): [Uint8Array, Uint8Array, Uint8Array]

Defined in util/key.ts:56

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: [Uint8Array, Uint8Array, Uint8Array]

getCommonPrefixLength

▸ getCommonPrefixLength(left: Uint8Array, right: Uint8Array): number

Defined in util/key.ts:46

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: number

keyEquals

▸ keyEquals(key: Uint8Array | null, test: Uint8Array | null): boolean

Defined in util/key.ts:10

Parameters:

Name Type
key Uint8Array | null
test Uint8Array | null

Returns: boolean

keyStartsWith

▸ keyStartsWith(key: Uint8Array | null, partial: Uint8Array | null): boolean

Defined in util/key.ts:20

Parameters:

Name Type
key Uint8Array | null
partial Uint8Array | null

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

computeExtensionKey

▸ computeExtensionKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:36

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

computeLeafKey

▸ computeLeafKey(nibbles: Uint8Array): EncodedPath

Defined in util/key.ts:40

Parameters:

Name Type
nibbles Uint8Array

Returns: EncodedPath

consumeCommonPrefix

▸ consumeCommonPrefix(left: Uint8Array, right: Uint8Array): [Uint8Array, Uint8Array, Uint8Array]

Defined in util/key.ts:56

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: [Uint8Array, Uint8Array, Uint8Array]

getCommonPrefixLength

▸ getCommonPrefixLength(left: Uint8Array, right: Uint8Array): number

Defined in util/key.ts:46

Parameters:

Name Type
left Uint8Array
right Uint8Array

Returns: number

keyEquals

▸ keyEquals(key: Uint8Array | null, test: Uint8Array | null): boolean

Defined in util/key.ts:10

Parameters:

Name Type
key Uint8Array | null
test Uint8Array | null

Returns: boolean

keyStartsWith

▸ keyStartsWith(key: Uint8Array | null, partial: Uint8Array | null): boolean

Defined in util/key.ts:20

Parameters:

Name Type
key Uint8Array | null
partial Uint8Array | null

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/modules/_util_key_.md b/docs/trie-db/modules/_util_key_.md index 2c9dac996..561e41a10 100644 --- a/docs/trie-db/modules/_util_key_.md +++ b/docs/trie-db/modules/_util_key_.md @@ -8,7 +8,7 @@ ▸ **computeExtensionKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath) -*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L36)* +*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L36)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **computeLeafKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath) -*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L40)* +*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L40)* **Parameters:** @@ -42,7 +42,7 @@ ___ ▸ **consumeCommonPrefix**(left: *`Uint8Array`*, right: *`Uint8Array`*): [`Uint8Array`, `Uint8Array`, `Uint8Array`] -*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L56)* +*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L56)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **getCommonPrefixLength**(left: *`Uint8Array`*, right: *`Uint8Array`*): `number` -*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L46)* +*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L46)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **keyEquals**(key: *`Uint8Array` \| `null`*, test: *`Uint8Array` \| `null`*): `boolean` -*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L10)* +*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L10)* **Parameters:** @@ -96,7 +96,7 @@ ___ ▸ **keyStartsWith**(key: *`Uint8Array` \| `null`*, partial: *`Uint8Array` \| `null`*): `boolean` -*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/key.ts#L20)* +*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/key.ts#L20)* **Parameters:** diff --git a/docs/trie-db/modules/_util_node_.html b/docs/trie-db/modules/_util_node_.html index 229e82fcc..0a9f9bb50 100644 --- a/docs/trie-db/modules/_util_node_.html +++ b/docs/trie-db/modules/_util_node_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeNode

▸ decodeNode(codec: Codec, encoded: Uint8Array | Node): Node

Defined in util/node.ts:30

Parameters:

Name Type
codec Codec
encoded Uint8Array | Node

Returns: Node

encodeNode

▸ encodeNode(codec: Codec, node: Node): Uint8Array

Defined in util/node.ts:46

Parameters:

Name Type
codec Codec
node Node

Returns: Uint8Array

getNodeType

▸ getNodeType(node: Node): NodeType

Defined in util/node.ts:13

Parameters:

Name Type
node Node

Returns: NodeType

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeNode

▸ decodeNode(codec: Codec, encoded: Uint8Array | Node): Node

Defined in util/node.ts:30

Parameters:

Name Type
codec Codec
encoded Uint8Array | Node

Returns: Node

encodeNode

▸ encodeNode(codec: Codec, node: Node): Uint8Array

Defined in util/node.ts:46

Parameters:

Name Type
codec Codec
node Node

Returns: Uint8Array

getNodeType

▸ getNodeType(node: Node): NodeType

Defined in util/node.ts:13

Parameters:

Name Type
node Node

Returns: NodeType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-db/modules/_util_node_.md b/docs/trie-db/modules/_util_node_.md index 10f794d7b..8aaf93f9f 100644 --- a/docs/trie-db/modules/_util_node_.md +++ b/docs/trie-db/modules/_util_node_.md @@ -8,7 +8,7 @@ ▸ **decodeNode**(codec: *`Codec`*, encoded: *`Uint8Array` \| [Node](_types_.md#node)*): [Node](_types_.md#node) -*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L30)* +*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L30)* **Parameters:** @@ -26,7 +26,7 @@ ___ ▸ **encodeNode**(codec: *`Codec`*, node: *[Node](_types_.md#node)*): `Uint8Array` -*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L46)* +*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L46)* **Parameters:** @@ -44,7 +44,7 @@ ___ ▸ **getNodeType**(node: *[Node](_types_.md#node)*): [NodeType](../enums/_types_.nodetype.md) -*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-db/src/util/node.ts#L13)* +*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-db/src/util/node.ts#L13)* **Parameters:** diff --git a/docs/trie-hash/SUMMARY.html b/docs/trie-hash/SUMMARY.html index a4c3a5b1d..48adb0576 100644 --- a/docs/trie-hash/SUMMARY.html +++ b/docs/trie-hash/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/trie-hash/index.html b/docs/trie-hash/index.html index 292e03e4b..637765dc7 100644 --- a/docs/trie-hash/index.html +++ b/docs/trie-hash/index.html @@ -7,7 +7,7 @@ - + @@ -15,9 +15,9 @@ GitHub

@polkadot/trie-hash

Calculate ordered and unordered Trie hashes from inputs.

Usage

Installation -

yarn add @polkadot/trie-hash
+

@polkadot/trie-hash

Calculate ordered and unordered Trie hashes from inputs.

Usage

Installation -

yarn add @polkadot/trie-hash
1

Functions can be imported as follows:

import { trieRoot } from '@polkadot/trie-hash';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/trie-hash/modules/_buildtrie_.html b/docs/trie-hash/modules/_buildtrie_.html index 90891fc77..30251454f 100644 --- a/docs/trie-hash/modules/_buildtrie_.html +++ b/docs/trie-hash/modules/_buildtrie_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

buildTrie

▸ buildTrie(input: Array<[Uint8Array, Uint8Array]>, cursor?: number, codec?: Codec, stream?: any): Uint8Array

Defined in buildTrie.ts:77

Parameters:

Name Type Default value
input Array<[Uint8Array, Uint8Array]> -
Default value cursor number 0
Default value codec Codec DEFAULT_CODEC
Default value stream any DEFAULT_STREAM

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

buildTrie

▸ buildTrie(input: Array<[Uint8Array, Uint8Array]>, cursor?: number, codec?: Codec, stream?: any): Uint8Array

Defined in buildTrie.ts:77

Parameters:

Name Type Default value
input Array<[Uint8Array, Uint8Array]> -
Default value cursor number 0
Default value codec Codec DEFAULT_CODEC
Default value stream any DEFAULT_STREAM

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-hash/modules/_buildtrie_.md b/docs/trie-hash/modules/_buildtrie_.md index d0f9a5511..2be0c0c61 100644 --- a/docs/trie-hash/modules/_buildtrie_.md +++ b/docs/trie-hash/modules/_buildtrie_.md @@ -8,7 +8,7 @@ ▸ **buildTrie**(input: *`Array`<[`Uint8Array`, `Uint8Array`]>*, cursor?: *`number`*, codec?: *`Codec`*, stream?: *`any`*): `Uint8Array` -*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/buildTrie.ts#L77)* +*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/buildTrie.ts#L77)* **Parameters:** diff --git a/docs/trie-hash/modules/_defaults_.html b/docs/trie-hash/modules/_defaults_.html index f165e657f..ee6dfad81 100644 --- a/docs/trie-hash/modules/_defaults_.html +++ b/docs/trie-hash/modules/_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/trie-hash/modules/_trieroot_.html b/docs/trie-hash/modules/_trieroot_.html index b949a3d35..058e7da6a 100644 --- a/docs/trie-hash/modules/_trieroot_.html +++ b/docs/trie-hash/modules/_trieroot_.html @@ -7,7 +7,7 @@ - + @@ -15,14 +15,14 @@ GitHub

Functions

trieRoot

▸ trieRoot(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in trieRoot.ts:29

name: trieRoot

summary: Creates a trie hash from the supplied pairs.

description: From an Array<{k: Uint8Array, v: Uint8Array}> input, calculate the triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

trieRoot

▸ trieRoot(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in trieRoot.ts:29

name: trieRoot

summary: Creates a trie hash from the supplied pairs.

description: From an Array<{k: Uint8Array, v: Uint8Array}> input, calculate the triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
 import { trieRoot } from '@polkadot/trie-hash';
 
 trieRoot([{
   k: stringToU8a('A'),
   v: stringToU8a('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
 }]); // => 0xd23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-hash/modules/_trieroot_.md b/docs/trie-hash/modules/_trieroot_.md index c30b8b891..41eb15793 100644 --- a/docs/trie-hash/modules/_trieroot_.md +++ b/docs/trie-hash/modules/_trieroot_.md @@ -8,7 +8,7 @@ ▸ **trieRoot**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/trieRoot.ts#L29)* +*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRoot.ts#L29)* *__name__*: trieRoot diff --git a/docs/trie-hash/modules/_trierootordered_.html b/docs/trie-hash/modules/_trierootordered_.html index 8c63087da..a93c8f068 100644 --- a/docs/trie-hash/modules/_trierootordered_.html +++ b/docs/trie-hash/modules/_trierootordered_.html @@ -7,7 +7,7 @@ - + @@ -15,14 +15,14 @@ GitHub

Functions

trieRootOrdered

▸ trieRootOrdered(input: Array<Uint8Array>, codec?: Codec): Uint8Array

Defined in trieRootOrdered.ts:30

name: trieRootOrdered

summary: Creates a trie hash from the supplied values.

description: From an Array<Uint8Array> input, calculate the ordered triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

trieRootOrdered

▸ trieRootOrdered(input: Array<Uint8Array>, codec?: Codec): Uint8Array

Defined in trieRootOrdered.ts:30

name: trieRootOrdered

summary: Creates a trie hash from the supplied values.

description: From an Array<Uint8Array> input, calculate the ordered triehash and return the result as a Uint8Array.

example:

import { stringToU8a } from '@polkadot/util';
 import { trieRootOrdered } from '@polkadot/trie-hash';
 
 trieRootOrdered([
   stringToU8a('doe'),
   stringToU8a('reindeer')
 ]); // => 0xe766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<Uint8Array> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7

Parameters:

Name Type Default value
input Array<Uint8Array> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-hash/modules/_trierootordered_.md b/docs/trie-hash/modules/_trierootordered_.md index ab8383939..a166a53e9 100644 --- a/docs/trie-hash/modules/_trierootordered_.md +++ b/docs/trie-hash/modules/_trierootordered_.md @@ -8,7 +8,7 @@ ▸ **trieRootOrdered**(input: *`Array`<`Uint8Array`>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/trieRootOrdered.ts#L30)* +*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/trieRootOrdered.ts#L30)* *__name__*: trieRootOrdered diff --git a/docs/trie-hash/modules/_types_.html b/docs/trie-hash/modules/_types_.html index f2ac4bca0..5bc2596b8 100644 --- a/docs/trie-hash/modules/_types_.html +++ b/docs/trie-hash/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

TriePair

Ƭ TriePair: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

TriePair

Ƭ TriePair: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-hash/modules/_types_.md b/docs/trie-hash/modules/_types_.md index 67e5dde3a..ca79c15d6 100644 --- a/docs/trie-hash/modules/_types_.md +++ b/docs/trie-hash/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ TriePair**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/types.ts#L5)* #### Type declaration diff --git a/docs/trie-hash/modules/_unhashedtrie_.html b/docs/trie-hash/modules/_unhashedtrie_.html index 4fc6a841e..9a2b44635 100644 --- a/docs/trie-hash/modules/_unhashedtrie_.html +++ b/docs/trie-hash/modules/_unhashedtrie_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

unhashedTrie

▸ unhashedTrie(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in unhashedTrie.ts:14

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

unhashedTrie

▸ unhashedTrie(input: Array<TriePair>, codec?: Codec): Uint8Array

Defined in unhashedTrie.ts:14

Parameters:

Name Type Default value
input Array<TriePair> -
Default value codec Codec DEFAULT_CODEC

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/trie-hash/modules/_unhashedtrie_.md b/docs/trie-hash/modules/_unhashedtrie_.md index eabcdc87c..e9854e2ae 100644 --- a/docs/trie-hash/modules/_unhashedtrie_.md +++ b/docs/trie-hash/modules/_unhashedtrie_.md @@ -8,7 +8,7 @@ ▸ **unhashedTrie**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array` -*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/4b1681d/packages/trie-hash/src/unhashedTrie.ts#L14)* +*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/815fdc7/packages/trie-hash/src/unhashedTrie.ts#L14)* **Parameters:** diff --git a/docs/util-crypto/SUMMARY.html b/docs/util-crypto/SUMMARY.html index 8e93dfb2c..0a5690ab8 100644 --- a/docs/util-crypto/SUMMARY.html +++ b/docs/util-crypto/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/util-crypto/index.html b/docs/util-crypto/index.html index bb01c21d5..fbed55bce 100644 --- a/docs/util-crypto/index.html +++ b/docs/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/util-crypto

Various useful cyrpto utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util-crypto
+

@polkadot/util-crypto

Various useful cyrpto utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util-crypto
1

Functions can be imported as follows:

import { mnemonicGenerate } from '@polkadot/util-crypto';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← - /keyring/ + @polkadot/keyring →

- + diff --git a/docs/util-crypto/modules/_blake2_ashex_.html b/docs/util-crypto/modules/_blake2_ashex_.html index 607f8ab22..a8c8146e4 100644 --- a/docs/util-crypto/modules/_blake2_ashex_.html +++ b/docs/util-crypto/modules/_blake2_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2AsHex

▸ blake2AsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/asHex.ts:21

name: blake2AsHex

summary: Creates a blake2b hex from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string with the specified bitLength.

example:

import { blake2AsHex } from '@polkadot/util-crypto';
+

Functions

blake2AsHex

▸ blake2AsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/asHex.ts:21

name: blake2AsHex

summary: Creates a blake2b hex from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string with the specified bitLength.

example:

import { blake2AsHex } from '@polkadot/util-crypto';
 
 blake2AsHex('abc'); // => 0xba80a53f981c4d0d
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_blake2_ashex_.md b/docs/util-crypto/modules/_blake2_ashex_.md index 3277699cd..fb4b4a43d 100644 --- a/docs/util-crypto/modules/_blake2_ashex_.md +++ b/docs/util-crypto/modules/_blake2_ashex_.md @@ -8,7 +8,7 @@ ▸ **blake2AsHex**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/asHex.ts#L21)* +*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asHex.ts#L21)* *__name__*: blake2AsHex diff --git a/docs/util-crypto/modules/_blake2_asu8a_.html b/docs/util-crypto/modules/_blake2_asu8a_.html index 2069dce56..fc3ae650f 100644 --- a/docs/util-crypto/modules/_blake2_asu8a_.html +++ b/docs/util-crypto/modules/_blake2_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2AsU8a

▸ blake2AsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array): Uint8Array

Defined in blake2/asU8a.ts:21

name: blake2AsU8a

summary: Creates a blake2b u8a from the input.

description: From a Uint8Array input, create the blake2b and return the result as a u8a with the specified bitLength.

example:

import { blake2AsU8a } from '@polkadot/util-crypto';
+

Functions

blake2AsU8a

▸ blake2AsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array): Uint8Array

Defined in blake2/asU8a.ts:21

name: blake2AsU8a

summary: Creates a blake2b u8a from the input.

description: From a Uint8Array input, create the blake2b and return the result as a u8a with the specified bitLength.

example:

import { blake2AsU8a } from '@polkadot/util-crypto';
 
 blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d]
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256
Optional key Uint8Array -

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 256
Optional key Uint8Array -

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_blake2_asu8a_.md b/docs/util-crypto/modules/_blake2_asu8a_.md index 47e54de95..0d9d88aeb 100644 --- a/docs/util-crypto/modules/_blake2_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_asu8a_.md @@ -8,7 +8,7 @@ ▸ **blake2AsU8a**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array` -*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/asU8a.ts#L21)* +*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/asU8a.ts#L21)* *__name__*: blake2AsU8a diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_.html b/docs/util-crypto/modules/_blake2_blake2b_ashex_.html index f20017ff3..2b5de65d1 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_ashex_.html +++ b/docs/util-crypto/modules/_blake2_blake2b_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2bAsHex

▸ blake2bAsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/blake2b/asHex.ts:23

name: blake2bAsHex

summary: Creates a blake2b hex string from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string.

example:

import { blake2bAsHex } from '@polkadot/util-crypto';
+

Functions

blake2bAsHex

▸ blake2bAsHex(data: Uint8Array | string, bitLength?: number): string

Defined in blake2/blake2b/asHex.ts:23

name: blake2bAsHex

summary: Creates a blake2b hex string from the input.

description: From a Uint8Array input, create the blake2b and return the result as a hex string.

example:

import { blake2bAsHex } from '@polkadot/util-crypto';
 
 blake2bAsHex('abc'); // => '0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923'
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md index c177ca76f..dab14a4fa 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md @@ -8,7 +8,7 @@ ▸ **blake2bAsHex**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* +*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* *__name__*: blake2bAsHex diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.html b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.html index d486acf72..e2834d8fc 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.html +++ b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

blake2bAsU8a

▸ blake2bAsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array | null): Uint8Array

Defined in blake2/blake2b/asU8a.ts:22

name: blake2bAsU8a

summary: Creates a blake2b Uint8Array from the input.

description: From a Uint8Array input, create the blake2b and return the result as a Uint8Array.

example:

import { blake2bAsU8a } from '@polkadot/util-crypto';
+

Functions

blake2bAsU8a

▸ blake2bAsU8a(data: Uint8Array | string, bitLength?: number, key?: Uint8Array | null): Uint8Array

Defined in blake2/blake2b/asU8a.ts:22

name: blake2bAsU8a

summary: Creates a blake2b Uint8Array from the input.

description: From a Uint8Array input, create the blake2b and return the result as a Uint8Array.

example:

import { blake2bAsU8a } from '@polkadot/util-crypto';
 
 blake2bAsU8a('abc'); // => Uint8Array('508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982')
-
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512
Default value key Uint8Array | null null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Uint8Array | string -
Default value bitLength number 512
Default value key Uint8Array | null null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md index e81dae347..e54e4d43f 100644 --- a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md +++ b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md @@ -8,7 +8,7 @@ ▸ **blake2bAsU8a**(data: *`Uint8Array` \| `string`*, bitLength?: *`number`*, key?: *`Uint8Array` \| `null`*): `Uint8Array` -*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* +*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* *__name__*: blake2bAsU8a diff --git a/docs/util-crypto/modules/_keccak_ashex_.html b/docs/util-crypto/modules/_keccak_ashex_.html index 4a7c332fd..2079b7326 100644 --- a/docs/util-crypto/modules/_keccak_ashex_.html +++ b/docs/util-crypto/modules/_keccak_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

keccakAsHex

▸ keccakAsHex(value: Buffer | Uint8Array | string): string

Defined in keccak/asHex.ts:23

name: keccakAsHex

summary: Creates a keccak hex string from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a 0x prefixed hex string.

example:

import { keccakAsHex } from '@polkadot/util-crypto';
+

Functions

keccakAsHex

▸ keccakAsHex(value: Buffer | Uint8Array | string): string

Defined in keccak/asHex.ts:23

name: keccakAsHex

summary: Creates a keccak hex string from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a 0x prefixed hex string.

example:

import { keccakAsHex } from '@polkadot/util-crypto';
 
 keccakAsHex('123'); // => 0x...
-
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_keccak_ashex_.md b/docs/util-crypto/modules/_keccak_ashex_.md index 87a531d54..bbd04113a 100644 --- a/docs/util-crypto/modules/_keccak_ashex_.md +++ b/docs/util-crypto/modules/_keccak_ashex_.md @@ -8,7 +8,7 @@ ▸ **keccakAsHex**(value: *`Buffer` \| `Uint8Array` \| `string`*): `string` -*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/keccak/asHex.ts#L23)* +*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asHex.ts#L23)* *__name__*: keccakAsHex diff --git a/docs/util-crypto/modules/_keccak_asu8a_.html b/docs/util-crypto/modules/_keccak_asu8a_.html index a8da15251..3fa9c0501 100644 --- a/docs/util-crypto/modules/_keccak_asu8a_.html +++ b/docs/util-crypto/modules/_keccak_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

keccakAsU8a

▸ keccakAsU8a(value: Buffer | Uint8Array | string): Uint8Array

Defined in keccak/asU8a.ts:21

name: keccakAsU8a

summary: Creates a keccak Uint8Array from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a Uint8Array.

example:

import { keccakAsU8a } from '@polkadot/util-crypto';
+

Functions

keccakAsU8a

▸ keccakAsU8a(value: Buffer | Uint8Array | string): Uint8Array

Defined in keccak/asU8a.ts:21

name: keccakAsU8a

summary: Creates a keccak Uint8Array from the input.

description: From either a string or a Buffer input, create the keccak and return the result as a Uint8Array.

example:

import { keccakAsU8a } from '@polkadot/util-crypto';
 
 keccakAsU8a('123'); // => Uint8Array
-
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_keccak_asu8a_.md b/docs/util-crypto/modules/_keccak_asu8a_.md index 1c3da2353..6333282eb 100644 --- a/docs/util-crypto/modules/_keccak_asu8a_.md +++ b/docs/util-crypto/modules/_keccak_asu8a_.md @@ -8,7 +8,7 @@ ▸ **keccakAsU8a**(value: *`Buffer` \| `Uint8Array` \| `string`*): `Uint8Array` -*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/keccak/asU8a.ts#L21)* +*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/keccak/asU8a.ts#L21)* *__name__*: keccakAsU8a diff --git a/docs/util-crypto/modules/_mnemonic_generate_.html b/docs/util-crypto/modules/_mnemonic_generate_.html index a32aaf432..43f0b4916 100644 --- a/docs/util-crypto/modules/_mnemonic_generate_.html +++ b/docs/util-crypto/modules/_mnemonic_generate_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

mnemonicGenerate

▸ mnemonicGenerate(strength?: Strength): string

Defined in mnemonic/generate.ts:21

name: mnemonicGenerate

summary: Creates a valid mnemonic string using using BIP39.

example:

import { mnemonicGenerate } from '@polkadot/util-crypto';
+

Functions

mnemonicGenerate

▸ mnemonicGenerate(strength?: Strength): string

Defined in mnemonic/generate.ts:21

name: mnemonicGenerate

summary: Creates a valid mnemonic string using using BIP39.

example:

import { mnemonicGenerate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
-
1
2
3

Parameters:

Name Type
Optional strength Strength

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional strength Strength

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_generate_.md b/docs/util-crypto/modules/_mnemonic_generate_.md index e637c2a66..740feb3e8 100644 --- a/docs/util-crypto/modules/_mnemonic_generate_.md +++ b/docs/util-crypto/modules/_mnemonic_generate_.md @@ -8,7 +8,7 @@ ▸ **mnemonicGenerate**(strength?: *`Strength`*): `string` -*Defined in [mnemonic/generate.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/generate.ts#L21)* +*Defined in [mnemonic/generate.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/generate.ts#L21)* *__name__*: mnemonicGenerate diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_.html b/docs/util-crypto/modules/_mnemonic_tosecret_.html index 32ce240f1..d86a6ec36 100644 --- a/docs/util-crypto/modules/_mnemonic_tosecret_.html +++ b/docs/util-crypto/modules/_mnemonic_tosecret_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toSecret

▸ toSecret(mnemonic: string): Uint8Array

Defined in mnemonic/toSecret.ts:8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toSecret

▸ toSecret(mnemonic: string): Uint8Array

Defined in mnemonic/toSecret.ts:8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_.md b/docs/util-crypto/modules/_mnemonic_tosecret_.md index a7c48e9ca..23779ff7b 100644 --- a/docs/util-crypto/modules/_mnemonic_tosecret_.md +++ b/docs/util-crypto/modules/_mnemonic_tosecret_.md @@ -8,7 +8,7 @@ ▸ **toSecret**(mnemonic: *`string`*): `Uint8Array` -*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* +*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* **Parameters:** diff --git a/docs/util-crypto/modules/_mnemonic_toseed_.html b/docs/util-crypto/modules/_mnemonic_toseed_.html index df6414e62..69e77e3db 100644 --- a/docs/util-crypto/modules/_mnemonic_toseed_.html +++ b/docs/util-crypto/modules/_mnemonic_toseed_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toSeed

▸ toSeed(mnemonic: string): Uint8Array

Defined in mnemonic/toSeed.ts:24

name: toSeed

summary: Creates a valid seed from a mnemonic input

example:

import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
+

Functions

toSeed

▸ toSeed(mnemonic: string): Uint8Array

Defined in mnemonic/toSeed.ts:24

name: toSeed

summary: Creates a valid seed from a mnemonic input

example:

import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
 const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
@@ -23,7 +23,7 @@
 if (isValidMnemonic) {
   console.log(`Seed generated from mnemonic: ${mnemonicToSeed(mnemonic)}`); => u8a
 }
-
1
2
3
4
5
6
7
8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6
7
8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_toseed_.md b/docs/util-crypto/modules/_mnemonic_toseed_.md index 1694126b0..c91130d64 100644 --- a/docs/util-crypto/modules/_mnemonic_toseed_.md +++ b/docs/util-crypto/modules/_mnemonic_toseed_.md @@ -8,7 +8,7 @@ ▸ **toSeed**(mnemonic: *`string`*): `Uint8Array` -*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* +*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* *__name__*: toSeed diff --git a/docs/util-crypto/modules/_mnemonic_validate_.html b/docs/util-crypto/modules/_mnemonic_validate_.html index c415bbb24..b61e4d313 100644 --- a/docs/util-crypto/modules/_mnemonic_validate_.html +++ b/docs/util-crypto/modules/_mnemonic_validate_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

mnemonicValidate

▸ mnemonicValidate(mnemonic: string): boolean

Defined in mnemonic/validate.ts:20

name: mnemonicValidate

summary: Validates a mnemonic input using BIP39.

example:

import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
+

Functions

mnemonicValidate

▸ mnemonicValidate(mnemonic: string): boolean

Defined in mnemonic/validate.ts:20

name: mnemonicValidate

summary: Validates a mnemonic input using BIP39.

example:

import { mnemonicGenerate, mnemonicValidate } from '@polkadot/util-crypto';
 
 const mnemonic = mnemonicGenerate(); // => string
 const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
-
1
2
3
4

Parameters:

Name Type
mnemonic string

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
mnemonic string

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_validate_.md b/docs/util-crypto/modules/_mnemonic_validate_.md index 9c46651ba..4900c4cbf 100644 --- a/docs/util-crypto/modules/_mnemonic_validate_.md +++ b/docs/util-crypto/modules/_mnemonic_validate_.md @@ -8,7 +8,7 @@ ▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean` -*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/mnemonic/validate.ts#L20)* +*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/mnemonic/validate.ts#L20)* *__name__*: mnemonicValidate diff --git a/docs/util-crypto/modules/_nacl_decrypt_.html b/docs/util-crypto/modules/_nacl_decrypt_.html index 11752ce4e..2ae4cda3a 100644 --- a/docs/util-crypto/modules/_nacl_decrypt_.html +++ b/docs/util-crypto/modules/_nacl_decrypt_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclDecrypt

▸ naclDecrypt(encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null

Defined in nacl/decrypt.ts:21

name: naclDecrypt

summary: Decrypts a message using the supplied secretKey and nonce

description: Returns an decrypted message, using the secret and nonce.

example:

import { naclDecrypt } from '@polkadot/util-crypto';
+

Functions

naclDecrypt

▸ naclDecrypt(encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null

Defined in nacl/decrypt.ts:21

name: naclDecrypt

summary: Decrypts a message using the supplied secretKey and nonce

description: Returns an decrypted message, using the secret and nonce.

example:

import { naclDecrypt } from '@polkadot/util-crypto';
 
 naclDecrypt([...], [...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type
encrypted Uint8Array
nonce Uint8Array
secret Uint8Array

Returns: Uint8Array | null

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
encrypted Uint8Array
nonce Uint8Array
secret Uint8Array

Returns: Uint8Array | null

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_decrypt_.md b/docs/util-crypto/modules/_nacl_decrypt_.md index 13daea20d..6bb0ecf47 100644 --- a/docs/util-crypto/modules/_nacl_decrypt_.md +++ b/docs/util-crypto/modules/_nacl_decrypt_.md @@ -8,7 +8,7 @@ ▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` \| `null` -*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/decrypt.ts#L21)* +*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/decrypt.ts#L21)* *__name__*: naclDecrypt diff --git a/docs/util-crypto/modules/_nacl_encrypt_.html b/docs/util-crypto/modules/_nacl_encrypt_.html index 00af07959..872d44211 100644 --- a/docs/util-crypto/modules/_nacl_encrypt_.html +++ b/docs/util-crypto/modules/_nacl_encrypt_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclEncrypt

▸ naclEncrypt(message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): Encrypted

Defined in nacl/encrypt.ts:28

name: naclEncrypt

summary: Encrypts a message using the supplied secretKey and nonce

description: Returns an encrypted message, using the secretKey and nonce. If the nonce was not supplied, a random value is generated.

example:

import { naclEncrypt } from '@polkadot/util-crypto';
+

Functions

naclEncrypt

▸ naclEncrypt(message: Uint8Array, secret: Uint8Array, nonce?: Uint8Array): Encrypted

Defined in nacl/encrypt.ts:28

name: naclEncrypt

summary: Encrypts a message using the supplied secretKey and nonce

description: Returns an encrypted message, using the secretKey and nonce. If the nonce was not supplied, a random value is generated.

example:

import { naclEncrypt } from '@polkadot/util-crypto';
 
 naclEncrypt([...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type Default value
message Uint8Array -
secret Uint8Array -
Default value nonce Uint8Array randomAsU8a(24)

Returns: Encrypted

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
message Uint8Array -
secret Uint8Array -
Default value nonce Uint8Array randomAsU8a(24)

Returns: Encrypted

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_encrypt_.md b/docs/util-crypto/modules/_nacl_encrypt_.md index 36961ab23..f572124bf 100644 --- a/docs/util-crypto/modules/_nacl_encrypt_.md +++ b/docs/util-crypto/modules/_nacl_encrypt_.md @@ -8,7 +8,7 @@ ▸ **naclEncrypt**(message: *`Uint8Array`*, secret: *`Uint8Array`*, nonce?: *`Uint8Array`*): `Encrypted` -*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/encrypt.ts#L28)* +*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/encrypt.ts#L28)* *__name__*: naclEncrypt diff --git a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.html b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.html index bbe0e99b3..b1cb90f8d 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.html +++ b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromRandom

▸ naclKeypairFromRandom(): KeypairType

Defined in nacl/keypair/fromRandom.ts:23

name: naclKeypairFromRandom

summary: Creates a new public/secret keypair.

description: Returns a new generate object containing a publicKey & secretKey.

example:

import { naclKeypairFromRandom } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromRandom

▸ naclKeypairFromRandom(): KeypairType

Defined in nacl/keypair/fromRandom.ts:23

name: naclKeypairFromRandom

summary: Creates a new public/secret keypair.

description: Returns a new generate object containing a publicKey & secretKey.

example:

import { naclKeypairFromRandom } from '@polkadot/util-crypto';
 
 naclKeypairFromRandom(); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md index 57c14c0cf..8c8f4f67a 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromRandom**(): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* +*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* *__name__*: naclKeypairFromRandom diff --git a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.html b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.html index bc220767f..cda47bdd5 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.html +++ b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromSecret

▸ naclKeypairFromSecret(secret: Uint8Array): KeypairType

Defined in nacl/keypair/fromSecret.ts:23

name: naclKeypairFromSecret

summary: Creates a new public/secret keypair from a secret.

description: Returns a object containing a publicKey & secretKey generated from the supplied secret.

example:

import { naclKeypairFromSecret } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromSecret

▸ naclKeypairFromSecret(secret: Uint8Array): KeypairType

Defined in nacl/keypair/fromSecret.ts:23

name: naclKeypairFromSecret

summary: Creates a new public/secret keypair from a secret.

description: Returns a object containing a publicKey & secretKey generated from the supplied secret.

example:

import { naclKeypairFromSecret } from '@polkadot/util-crypto';
 
 naclKeypairFromSecret(...); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
secret Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
secret Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md index 49d91498e..d03d2d97f 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromSecret**(secret: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* +*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* *__name__*: naclKeypairFromSecret diff --git a/docs/util-crypto/modules/_nacl_keypair_fromseed_.html b/docs/util-crypto/modules/_nacl_keypair_fromseed_.html index 8a7a75f3a..710105b46 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromseed_.html +++ b/docs/util-crypto/modules/_nacl_keypair_fromseed_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromSeed

▸ naclKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in nacl/keypair/fromSeed.ts:23

name: naclKeypairFromSeed

summary: Creates a new public/secret keypair from a seed.

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

example:

import { naclKeypairFromSeed } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromSeed

▸ naclKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in nacl/keypair/fromSeed.ts:23

name: naclKeypairFromSeed

summary: Creates a new public/secret keypair from a seed.

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

example:

import { naclKeypairFromSeed } from '@polkadot/util-crypto';
 
 naclKeypairFromSeed(...); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md index c78c973a0..c4722d854 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* +*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* *__name__*: naclKeypairFromSeed diff --git a/docs/util-crypto/modules/_nacl_keypair_fromstring_.html b/docs/util-crypto/modules/_nacl_keypair_fromstring_.html index faec91aa1..2d0db232e 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromstring_.html +++ b/docs/util-crypto/modules/_nacl_keypair_fromstring_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclKeypairFromString

▸ naclKeypairFromString(value: string): KeypairType

Defined in nacl/keypair/fromString.ts:26

name: naclKeypairFromString

summary: Creates a new public/secret keypair from a string.

description: Returns a object containing a publicKey & secretKey generated from the supplied string. The string is hashed and the value used as the input seed.

example:

import { naclKeypairFromString } from '@polkadot/util-crypto';
+

Functions

naclKeypairFromString

▸ naclKeypairFromString(value: string): KeypairType

Defined in nacl/keypair/fromString.ts:26

name: naclKeypairFromString

summary: Creates a new public/secret keypair from a string.

description: Returns a object containing a publicKey & secretKey generated from the supplied string. The string is hashed and the value used as the input seed.

example:

import { naclKeypairFromString } from '@polkadot/util-crypto';
 
 naclKeypairFromString('test'); // => { secretKey: [...], publicKey: [...] }
-
1
2
3

Parameters:

Name Type
value string

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value string

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md index db9d47c73..f79a181a6 100644 --- a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md +++ b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md @@ -8,7 +8,7 @@ ▸ **naclKeypairFromString**(value: *`string`*): [KeypairType](_types_.md#keypairtype) -*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* +*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* *__name__*: naclKeypairFromString diff --git a/docs/util-crypto/modules/_nacl_sign_.html b/docs/util-crypto/modules/_nacl_sign_.html index 08b967594..16deaf772 100644 --- a/docs/util-crypto/modules/_nacl_sign_.html +++ b/docs/util-crypto/modules/_nacl_sign_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclSign

▸ naclSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in nacl/sign.ts:24

name: naclSign

summary: Signs a message using the supplied secretKey

description: Returns message signature of message, using the secretKey.

example:

import { naclSign } from '@polkadot/util-crypto';
+

Functions

naclSign

▸ naclSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in nacl/sign.ts:24

name: naclSign

summary: Signs a message using the supplied secretKey

description: Returns message signature of message, using the secretKey.

example:

import { naclSign } from '@polkadot/util-crypto';
 
 naclSign([...], [...]); // => [...]
-
1
2
3

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_sign_.md b/docs/util-crypto/modules/_nacl_sign_.md index 603a7025e..53b4ba8e6 100644 --- a/docs/util-crypto/modules/_nacl_sign_.md +++ b/docs/util-crypto/modules/_nacl_sign_.md @@ -8,7 +8,7 @@ ▸ **naclSign**(message: *`Uint8Array`*, __namedParameters: *`object`*): `Uint8Array` -*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/sign.ts#L24)* +*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/sign.ts#L24)* *__name__*: naclSign diff --git a/docs/util-crypto/modules/_nacl_verify_.html b/docs/util-crypto/modules/_nacl_verify_.html index b629a2c65..d08cac2a8 100644 --- a/docs/util-crypto/modules/_nacl_verify_.html +++ b/docs/util-crypto/modules/_nacl_verify_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

naclVerify

▸ naclVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in nacl/verify.ts:21

name: naclSign

summary: Verifies the signature on the supplied message.

description: Verifies the signature on message with the supplied plublicKey. Returns true on sucess, false otherwise.

example:

import { naclVerify } from '@polkadot/util-crypto';
+

Functions

naclVerify

▸ naclVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in nacl/verify.ts:21

name: naclSign

summary: Verifies the signature on the supplied message.

description: Verifies the signature on message with the supplied plublicKey. Returns true on sucess, false otherwise.

example:

import { naclVerify } from '@polkadot/util-crypto';
 
 naclVerify([...], [...], [...]); // => true/false
-
1
2
3

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_nacl_verify_.md b/docs/util-crypto/modules/_nacl_verify_.md index ab342d2c9..1c6f63d51 100644 --- a/docs/util-crypto/modules/_nacl_verify_.md +++ b/docs/util-crypto/modules/_nacl_verify_.md @@ -8,7 +8,7 @@ ▸ **naclVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean` -*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/nacl/verify.ts#L21)* +*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/nacl/verify.ts#L21)* *__name__*: naclSign diff --git a/docs/util-crypto/modules/_random_ashex_.html b/docs/util-crypto/modules/_random_ashex_.html index 704ce2ffb..84d48f9c2 100644 --- a/docs/util-crypto/modules/_random_ashex_.html +++ b/docs/util-crypto/modules/_random_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsHex

▸ randomAsHex(length?: number): string

Defined in random/asHex.ts:23

name: randomAsHex

summary: Creates a hex string filled with random bytes.

description: Returns a hex string with the specified (optional) length filled with random bytes.

example:

import { randomAsHex } from '@polkadot/util-crypto';
+

Functions

randomAsHex

▸ randomAsHex(length?: number): string

Defined in random/asHex.ts:23

name: randomAsHex

summary: Creates a hex string filled with random bytes.

description: Returns a hex string with the specified (optional) length filled with random bytes.

example:

import { randomAsHex } from '@polkadot/util-crypto';
 
 randomAsHex(); // => 0x...
-
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_random_ashex_.md b/docs/util-crypto/modules/_random_ashex_.md index 2655cf70c..a90e1c9ba 100644 --- a/docs/util-crypto/modules/_random_ashex_.md +++ b/docs/util-crypto/modules/_random_ashex_.md @@ -8,7 +8,7 @@ ▸ **randomAsHex**(length?: *`number`*): `string` -*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asHex.ts#L23)* +*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asHex.ts#L23)* *__name__*: randomAsHex diff --git a/docs/util-crypto/modules/_random_asnumber_.html b/docs/util-crypto/modules/_random_asnumber_.html index 2aa2cf2e3..8d59ee36d 100644 --- a/docs/util-crypto/modules/_random_asnumber_.html +++ b/docs/util-crypto/modules/_random_asnumber_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsNumber

▸ randomAsNumber(): number

Defined in random/asNumber.ts:26

name: randomAsNumber

summary: Creates a random number from random bytes.

description: Returns a random number generated from the secure bytes.

example:

import { randomAsNumber } from '@polkadot/util-crypto';
+

Functions

randomAsNumber

▸ randomAsNumber(): number

Defined in random/asNumber.ts:26

name: randomAsNumber

summary: Creates a random number from random bytes.

description: Returns a random number generated from the secure bytes.

example:

import { randomAsNumber } from '@polkadot/util-crypto';
 
 randomAsNumber(); // => <random number>
-
1
2
3

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_random_asnumber_.md b/docs/util-crypto/modules/_random_asnumber_.md index b1ffe949a..a90009ba9 100644 --- a/docs/util-crypto/modules/_random_asnumber_.md +++ b/docs/util-crypto/modules/_random_asnumber_.md @@ -8,7 +8,7 @@ ▸ **randomAsNumber**(): `number` -*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asNumber.ts#L26)* +*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asNumber.ts#L26)* *__name__*: randomAsNumber diff --git a/docs/util-crypto/modules/_random_asu8a_.html b/docs/util-crypto/modules/_random_asu8a_.html index 086ebd5e9..6765c98d1 100644 --- a/docs/util-crypto/modules/_random_asu8a_.html +++ b/docs/util-crypto/modules/_random_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

randomAsU8a

▸ randomAsU8a(length?: number): Uint8Array

Defined in random/asU8a.ts:21

name: randomAsU8a

summary: Creates a Uint8Array filled with random bytes.

description: Returns a Uint8Array with the specified (optional) length filled with random bytes.

example:

import { randomAsU8a } from '@polkadot/util-crypto';
+

Functions

randomAsU8a

▸ randomAsU8a(length?: number): Uint8Array

Defined in random/asU8a.ts:21

name: randomAsU8a

summary: Creates a Uint8Array filled with random bytes.

description: Returns a Uint8Array with the specified (optional) length filled with random bytes.

example:

import { randomAsU8a } from '@polkadot/util-crypto';
 
 randomAsU8a(); // => Uint8Array([...])
-
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_random_asu8a_.md b/docs/util-crypto/modules/_random_asu8a_.md index face7a687..8cebeb632 100644 --- a/docs/util-crypto/modules/_random_asu8a_.md +++ b/docs/util-crypto/modules/_random_asu8a_.md @@ -8,7 +8,7 @@ ▸ **randomAsU8a**(length?: *`number`*): `Uint8Array` -*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/random/asU8a.ts#L21)* +*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/random/asU8a.ts#L21)* *__name__*: randomAsU8a diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.html b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.html index a58c661df..ab8da608d 100644 --- a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.html +++ b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelKeypairFromSeed

▸ schnorrkelKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in schnorrkel/keypair/fromSeed.ts:16

name: schnorrkelKeypairFromSeed

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelKeypairFromSeed

▸ schnorrkelKeypairFromSeed(seed: Uint8Array): KeypairType

Defined in schnorrkel/keypair/fromSeed.ts:16

name: schnorrkelKeypairFromSeed

description: Returns a object containing a publicKey & secretKey generated from the supplied seed.

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md index 91f783e9a..bec56edcc 100644 --- a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md +++ b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype) -*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* +*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* *__name__*: schnorrkelKeypairFromSeed diff --git a/docs/util-crypto/modules/_schnorrkel_ready_.html b/docs/util-crypto/modules/_schnorrkel_ready_.html index a7c5a67f4..38ae800e0 100644 --- a/docs/util-crypto/modules/_schnorrkel_ready_.html +++ b/docs/util-crypto/modules/_schnorrkel_ready_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelIsReady

▸ schnorrkelIsReady(): boolean

Defined in schnorrkel/ready.ts:11

Returns: boolean

schnorrkelWaitReady

▸ schnorrkelWaitReady(): Promise<boolean>

Defined in schnorrkel/ready.ts:7

Returns: Promise<boolean>

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelIsReady

▸ schnorrkelIsReady(): boolean

Defined in schnorrkel/ready.ts:11

Returns: boolean

schnorrkelWaitReady

▸ schnorrkelWaitReady(): Promise<boolean>

Defined in schnorrkel/ready.ts:7

Returns: Promise<boolean>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_ready_.md b/docs/util-crypto/modules/_schnorrkel_ready_.md index aa724ebe7..91f7152fb 100644 --- a/docs/util-crypto/modules/_schnorrkel_ready_.md +++ b/docs/util-crypto/modules/_schnorrkel_ready_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelIsReady**(): `boolean` -*Defined in [schnorrkel/ready.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/ready.ts#L11)* +*Defined in [schnorrkel/ready.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L11)* **Returns:** `boolean` @@ -19,7 +19,7 @@ ___ ▸ **schnorrkelWaitReady**(): `Promise`<`boolean`> -*Defined in [schnorrkel/ready.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/ready.ts#L7)* +*Defined in [schnorrkel/ready.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L7)* **Returns:** `Promise`<`boolean`> diff --git a/docs/util-crypto/modules/_schnorrkel_sign_.html b/docs/util-crypto/modules/_schnorrkel_sign_.html index 0123227f7..043468d26 100644 --- a/docs/util-crypto/modules/_schnorrkel_sign_.html +++ b/docs/util-crypto/modules/_schnorrkel_sign_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelSign

▸ schnorrkelSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in schnorrkel/sign.ts:15

name: schnorrkelSign

description: Returns message signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelSign

▸ schnorrkelSign(message: Uint8Array, __namedParameters: object): Uint8Array

Defined in schnorrkel/sign.ts:15

name: schnorrkelSign

description: Returns message signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_sign_.md b/docs/util-crypto/modules/_schnorrkel_sign_.md index 0bfdbd430..1ad0a1259 100644 --- a/docs/util-crypto/modules/_schnorrkel_sign_.md +++ b/docs/util-crypto/modules/_schnorrkel_sign_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelSign**(message: *`Uint8Array`*, __namedParameters: *`object`*): `Uint8Array` -*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/sign.ts#L15)* +*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/sign.ts#L15)* *__name__*: schnorrkelSign diff --git a/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html b/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html index 13938e1ee..ce831befd 100644 --- a/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html +++ b/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/19/2019, 3:11:49 PM
- +
Last Updated: 2/19/2019, 3:11:49 PM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_verify_.html b/docs/util-crypto/modules/_schnorrkel_verify_.html index 1dd030527..0606f0405 100644 --- a/docs/util-crypto/modules/_schnorrkel_verify_.html +++ b/docs/util-crypto/modules/_schnorrkel_verify_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

schnorrkelVerify

▸ schnorrkelVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in schnorrkel/verify.ts:11

name: schnorrkelVerify

description: Verifies the signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

schnorrkelVerify

▸ schnorrkelVerify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean

Defined in schnorrkel/verify.ts:11

name: schnorrkelVerify

description: Verifies the signature of message, using the supplied pair

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_verify_.md b/docs/util-crypto/modules/_schnorrkel_verify_.md index 3a6ad9f2a..90984f5df 100644 --- a/docs/util-crypto/modules/_schnorrkel_verify_.md +++ b/docs/util-crypto/modules/_schnorrkel_verify_.md @@ -8,7 +8,7 @@ ▸ **schnorrkelVerify**(message: *`Uint8Array`*, signature: *`Uint8Array`*, publicKey: *`Uint8Array`*): `boolean` -*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/schnorrkel/verify.ts#L11)* +*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/schnorrkel/verify.ts#L11)* *__name__*: schnorrkelVerify diff --git a/docs/util-crypto/modules/_secp256k1_recover_.html b/docs/util-crypto/modules/_secp256k1_recover_.html index fc0b06a55..e2c30e4cb 100644 --- a/docs/util-crypto/modules/_secp256k1_recover_.html +++ b/docs/util-crypto/modules/_secp256k1_recover_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

secp256k1Recover

▸ secp256k1Recover(_message: Uint8Array, _signature: Uint8Array, recovery: number): Uint8Array

Defined in secp256k1/recover.ts:12

name: secp256k1Recover

description: Recovers a publicKey from the supplied signature

Parameters:

Name Type
_message Uint8Array
_signature Uint8Array
recovery number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

secp256k1Recover

▸ secp256k1Recover(_message: Uint8Array, _signature: Uint8Array, recovery: number): Uint8Array

Defined in secp256k1/recover.ts:12

name: secp256k1Recover

description: Recovers a publicKey from the supplied signature

Parameters:

Name Type
_message Uint8Array
_signature Uint8Array
recovery number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_secp256k1_recover_.md b/docs/util-crypto/modules/_secp256k1_recover_.md index f16ac932b..42e5d3823 100644 --- a/docs/util-crypto/modules/_secp256k1_recover_.md +++ b/docs/util-crypto/modules/_secp256k1_recover_.md @@ -8,7 +8,7 @@ ▸ **secp256k1Recover**(_message: *`Uint8Array`*, _signature: *`Uint8Array`*, recovery: *`number`*): `Uint8Array` -*Defined in [secp256k1/recover.ts:12](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/secp256k1/recover.ts#L12)* +*Defined in [secp256k1/recover.ts:12](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/secp256k1/recover.ts#L12)* *__name__*: secp256k1Recover diff --git a/docs/util-crypto/modules/_sha512_asu8a_.html b/docs/util-crypto/modules/_sha512_asu8a_.html index e41b1d2bf..d3ff5d071 100644 --- a/docs/util-crypto/modules/_sha512_asu8a_.html +++ b/docs/util-crypto/modules/_sha512_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

sha512AsU8a

▸ sha512AsU8a(data: Uint8Array): Uint8Array

Defined in sha512/asU8a.ts:21

name: sha512AsU8a

summary: Creates sha-512 hash of the input.

description: Returns a sha-512 Uint8Array from the supplied data.

example:

import { sha512AsU8a } from '@polkadot/util-crypto';
+

Functions

sha512AsU8a

▸ sha512AsU8a(data: Uint8Array): Uint8Array

Defined in sha512/asU8a.ts:21

name: sha512AsU8a

summary: Creates sha-512 hash of the input.

description: Returns a sha-512 Uint8Array from the supplied data.

example:

import { sha512AsU8a } from '@polkadot/util-crypto';
 
 sha512AsU8a(Uint8Array.from([...])); // => Uint8Array([...])
-
1
2
3

Parameters:

Name Type
data Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_sha512_asu8a_.md b/docs/util-crypto/modules/_sha512_asu8a_.md index 668e4e953..038960a04 100644 --- a/docs/util-crypto/modules/_sha512_asu8a_.md +++ b/docs/util-crypto/modules/_sha512_asu8a_.md @@ -8,7 +8,7 @@ ▸ **sha512AsU8a**(data: *`Uint8Array`*): `Uint8Array` -*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/sha512/asU8a.ts#L21)* +*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/sha512/asU8a.ts#L21)* *__name__*: sha512AsU8a diff --git a/docs/util-crypto/modules/_types_.html b/docs/util-crypto/modules/_types_.html index 89ca74e1e..7fcbb4eef 100644 --- a/docs/util-crypto/modules/_types_.html +++ b/docs/util-crypto/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

KeypairType

Ƭ KeypairType: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

KeypairType

Ƭ KeypairType: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_types_.md b/docs/util-crypto/modules/_types_.md index f901ff5ec..8d87006f9 100644 --- a/docs/util-crypto/modules/_types_.md +++ b/docs/util-crypto/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ KeypairType**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/types.ts#L5)* #### Type declaration diff --git a/docs/util-crypto/modules/_xxhash_ashex_.html b/docs/util-crypto/modules/_xxhash_ashex_.html index 21524eb20..9afeee0a8 100644 --- a/docs/util-crypto/modules/_xxhash_ashex_.html +++ b/docs/util-crypto/modules/_xxhash_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhashAsHex

▸ xxhashAsHex(data: Buffer | Uint8Array | string, bitLength?: number): string

Defined in xxhash/asHex.ts:23

name: xxhashAsHex

summary: Creates a xxhash64 hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a hex string with the specified bitLength.

example:

import { xxhashAsHex } from '@polkadot/util-crypto';
+

Functions

xxhashAsHex

▸ xxhashAsHex(data: Buffer | Uint8Array | string, bitLength?: number): string

Defined in xxhash/asHex.ts:23

name: xxhashAsHex

summary: Creates a xxhash64 hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a hex string with the specified bitLength.

example:

import { xxhashAsHex } from '@polkadot/util-crypto';
 
 xxhashAsHex('abc'); // => 0x44bc2cf5ad770999
-
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_ashex_.md b/docs/util-crypto/modules/_xxhash_ashex_.md index d239603c7..915564dfe 100644 --- a/docs/util-crypto/modules/_xxhash_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_ashex_.md @@ -8,7 +8,7 @@ ▸ **xxhashAsHex**(data: *`Buffer` \| `Uint8Array` \| `string`*, bitLength?: *`number`*): `string` -*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/asHex.ts#L23)* +*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asHex.ts#L23)* *__name__*: xxhashAsHex diff --git a/docs/util-crypto/modules/_xxhash_asu8a_.html b/docs/util-crypto/modules/_xxhash_asu8a_.html index d61a870d4..bec694682 100644 --- a/docs/util-crypto/modules/_xxhash_asu8a_.html +++ b/docs/util-crypto/modules/_xxhash_asu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhashAsU8a

▸ xxhashAsU8a(data: Buffer | Uint8Array | string, bitLength?: number): Uint8Array

Defined in xxhash/asU8a.ts:21

name: xxhashAsU8a

summary: Creates a xxhash64 u8a from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a Uint8Array with the specified bitLength.

example:

import { xxhashAsU8a } from '@polkadot/util-crypto';
+

Functions

xxhashAsU8a

▸ xxhashAsU8a(data: Buffer | Uint8Array | string, bitLength?: number): Uint8Array

Defined in xxhash/asU8a.ts:21

name: xxhashAsU8a

summary: Creates a xxhash64 u8a from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash64 and return the result as a Uint8Array with the specified bitLength.

example:

import { xxhashAsU8a } from '@polkadot/util-crypto';
 
 xxhashAsU8a('abc'); // => 0x44bc2cf5ad770999
-
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
data Buffer | Uint8Array | string -
Default value bitLength number 64

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_asu8a_.md b/docs/util-crypto/modules/_xxhash_asu8a_.md index c66a24489..286c50de1 100644 --- a/docs/util-crypto/modules/_xxhash_asu8a_.md +++ b/docs/util-crypto/modules/_xxhash_asu8a_.md @@ -8,7 +8,7 @@ ▸ **xxhashAsU8a**(data: *`Buffer` \| `Uint8Array` \| `string`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/asU8a.ts#L21)* +*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/asU8a.ts#L21)* *__name__*: xxhashAsU8a diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.html b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.html index b2cfb53e8..46a56504f 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.html +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsBn

▸ xxhash64AsBn(data: Buffer | Uint8Array | string, seed: number): BN

Defined in xxhash/xxhash64/asBn.ts:23

name: xxhash64AsBn

summary: Creates a xxhash BN from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a BN.

example:

import { xxhash64AsNumber } from '@polkadot/util-crypto';
+

Functions

xxhash64AsBn

▸ xxhash64AsBn(data: Buffer | Uint8Array | string, seed: number): BN

Defined in xxhash/xxhash64/asBn.ts:23

name: xxhash64AsBn

summary: Creates a xxhash BN from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a BN.

example:

import { xxhash64AsNumber } from '@polkadot/util-crypto';
 
 xxhash64AsBn('abcd', 0xabcd)); // => new BN(0xe29f70f8b8c96df7)
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md index 26217c6db..6a15ba666 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md @@ -8,7 +8,7 @@ ▸ **xxhash64AsBn**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `BN` -*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* +*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* *__name__*: xxhash64AsBn diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.html b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.html index 271e777c0..06044e7ba 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.html +++ b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsHex

▸ xxhash64AsHex(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asHex.ts:23

name: xxhash64AsHex

summary: Creates a xxhash hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex string.

example:

import { xxhash64AsHex } from '@polkadot/util-crypto';
+

Functions

xxhash64AsHex

▸ xxhash64AsHex(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asHex.ts:23

name: xxhash64AsHex

summary: Creates a xxhash hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex string.

example:

import { xxhash64AsHex } from '@polkadot/util-crypto';
 
 xxhash64AsHex('abcd', 0xabcd)); // => 0xe29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md index 37e8586cc..4cdaa54ae 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md @@ -8,7 +8,7 @@ ▸ **xxhash64AsHex**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* +*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* *__name__*: xxhash64AsHex diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.html b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.html index 2aebb59d1..b5cffcbf0 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.html +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsRaw

▸ xxhash64AsRaw(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asRaw.ts:21

name: xxhash64AsRaw

summary: Creates a xxhash non-prefixed hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a non-prefixed hex string.

example:

import { xxhash64AsRaw } from '@polkadot/util-crypto';
+

Functions

xxhash64AsRaw

▸ xxhash64AsRaw(data: Buffer | Uint8Array | string, seed: number): string

Defined in xxhash/xxhash64/asRaw.ts:21

name: xxhash64AsRaw

summary: Creates a xxhash non-prefixed hex from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a non-prefixed hex string.

example:

import { xxhash64AsRaw } from '@polkadot/util-crypto';
 
 xxhash64AsRaw('abcd', 0xabcd)); // => e29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md index 66547a426..71e5aa03a 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md @@ -8,7 +8,7 @@ ▸ **xxhash64AsRaw**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `string` -*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* +*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* *__name__*: xxhash64AsRaw diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.html b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.html index 5f02f0b9f..c48114690 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.html +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

xxhash64AsValue

▸ xxhash64AsValue(data: Buffer | Uint8Array | string, seed: number): number

Defined in xxhash/xxhash64/asValue.ts:22

name: xxhash64AsValue

summary: Creates a hex number from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex number

example:

import { xxhash64AsValue } from '@polkadot/util-crypto';
+

Functions

xxhash64AsValue

▸ xxhash64AsValue(data: Buffer | Uint8Array | string, seed: number): number

Defined in xxhash/xxhash64/asValue.ts:22

name: xxhash64AsValue

summary: Creates a hex number from the input.

description: From either a string, Uint8Array or a Buffer input, create the xxhash and return the result as a hex number

example:

import { xxhash64AsValue } from '@polkadot/util-crypto';
 
 xxhash64AsValue('abcd', 0xabcd)); // => e29f70f8b8c96df7
-
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md index bd2ee40ca..7d2282a03 100644 --- a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md +++ b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md @@ -8,7 +8,7 @@ ▸ **xxhash64AsValue**(data: *`Buffer` \| `Uint8Array` \| `string`*, seed: *`number`*): `number` -*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* +*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* *__name__*: xxhash64AsValue diff --git a/docs/util-rlp/SUMMARY.html b/docs/util-rlp/SUMMARY.html index ad112de68..6f7061e18 100644 --- a/docs/util-rlp/SUMMARY.html +++ b/docs/util-rlp/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/util-rlp/index.html b/docs/util-rlp/index.html index b3fd33b4b..4e822902b 100644 --- a/docs/util-rlp/index.html +++ b/docs/util-rlp/index.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

@polkadot/util-rlp

Utility methods for encoding and decoding Ethereum RLP structures. This is port adapted from the original EthereumJS RLP implementation to cater for Uint8Array outputs (instead of Buffer) in addition to typings.

Usage

Installation -

yarn add @polkadot/util-rlp
+

@polkadot/util-rlp

Utility methods for encoding and decoding Ethereum RLP structures. This is port adapted from the original EthereumJS RLP implementation to cater for Uint8Array outputs (instead of Buffer) in addition to typings.

Usage

Installation -

yarn add @polkadot/util-rlp
1

Functions can be imported as follows:

import { decode } from '@polkadot/util-rlp';
 import { encode } from '@polkadot/util-rlp';
1
2

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/util-rlp/modules/_decode_.html b/docs/util-rlp/modules/_decode_.html index 07c4424d2..d3b1f3d03 100644 --- a/docs/util-rlp/modules/_decode_.html +++ b/docs/util-rlp/modules/_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util-rlp/modules/_decoder_decode_.html b/docs/util-rlp/modules/_decoder_decode_.html index 8b7832009..3f0d347ab 100644 --- a/docs/util-rlp/modules/_decoder_decode_.html +++ b/docs/util-rlp/modules/_decoder_decode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decode

▸ decode(input: Uint8Array): DecodeOutput

Defined in decoder/decode.ts:28

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decode

▸ decode(input: Uint8Array): DecodeOutput

Defined in decoder/decode.ts:28

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_decode_.md b/docs/util-rlp/modules/_decoder_decode_.md index 49834ceb4..2e5d54d2b 100644 --- a/docs/util-rlp/modules/_decoder_decode_.md +++ b/docs/util-rlp/modules/_decoder_decode_.md @@ -8,7 +8,7 @@ ▸ **decode**(input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/decode.ts#L28)* +*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/decode.ts#L28)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_listlong_.html b/docs/util-rlp/modules/_decoder_listlong_.html index bdcd49cab..f124980f4 100644 --- a/docs/util-rlp/modules/_decoder_listlong_.html +++ b/docs/util-rlp/modules/_decoder_listlong_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeListLong

▸ decodeListLong(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listLong.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeListLong

▸ decodeListLong(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listLong.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_listlong_.md b/docs/util-rlp/modules/_decoder_listlong_.md index 8d27534cd..00e2fd2bc 100644 --- a/docs/util-rlp/modules/_decoder_listlong_.md +++ b/docs/util-rlp/modules/_decoder_listlong_.md @@ -8,7 +8,7 @@ ▸ **decodeListLong**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/listLong.ts#L11)* +*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listLong.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_listshort_.html b/docs/util-rlp/modules/_decoder_listshort_.html index de5dde7f9..da1f5e67a 100644 --- a/docs/util-rlp/modules/_decoder_listshort_.html +++ b/docs/util-rlp/modules/_decoder_listshort_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeListShort

▸ decodeListShort(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listShort.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeListShort

▸ decodeListShort(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/listShort.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_listshort_.md b/docs/util-rlp/modules/_decoder_listshort_.md index 462d9aeb1..2e01e68b7 100644 --- a/docs/util-rlp/modules/_decoder_listshort_.md +++ b/docs/util-rlp/modules/_decoder_listshort_.md @@ -8,7 +8,7 @@ ▸ **decodeListShort**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/listShort.ts#L7)* +*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/listShort.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_number_.html b/docs/util-rlp/modules/_decoder_number_.html index 6fc9ebaa1..b661a269b 100644 --- a/docs/util-rlp/modules/_decoder_number_.html +++ b/docs/util-rlp/modules/_decoder_number_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeNumber

▸ decodeNumber(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/number.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeNumber

▸ decodeNumber(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/number.ts:11

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_number_.md b/docs/util-rlp/modules/_decoder_number_.md index 5530b2b12..e36fe59b0 100644 --- a/docs/util-rlp/modules/_decoder_number_.md +++ b/docs/util-rlp/modules/_decoder_number_.md @@ -8,7 +8,7 @@ ▸ **decodeNumber**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/number.ts#L11)* +*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/number.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_safeparseint_.html b/docs/util-rlp/modules/_decoder_safeparseint_.html index 3a34d1822..ad8df1ad1 100644 --- a/docs/util-rlp/modules/_decoder_safeparseint_.html +++ b/docs/util-rlp/modules/_decoder_safeparseint_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

safeParseInt

▸ safeParseInt(input: Uint8Array): number

Defined in decoder/safeParseInt.ts:7

Parameters:

Name Type
input Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

safeParseInt

▸ safeParseInt(input: Uint8Array): number

Defined in decoder/safeParseInt.ts:7

Parameters:

Name Type
input Uint8Array

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_safeparseint_.md b/docs/util-rlp/modules/_decoder_safeparseint_.md index 250a5f851..59a079f99 100644 --- a/docs/util-rlp/modules/_decoder_safeparseint_.md +++ b/docs/util-rlp/modules/_decoder_safeparseint_.md @@ -8,7 +8,7 @@ ▸ **safeParseInt**(input: *`Uint8Array`*): `number` -*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* +*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_single_.html b/docs/util-rlp/modules/_decoder_single_.html index 4a126ca8f..f92071561 100644 --- a/docs/util-rlp/modules/_decoder_single_.html +++ b/docs/util-rlp/modules/_decoder_single_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeSingle

▸ decodeSingle(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/single.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeSingle

▸ decodeSingle(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/single.ts:7

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_single_.md b/docs/util-rlp/modules/_decoder_single_.md index ddd798980..d6a6c6ab2 100644 --- a/docs/util-rlp/modules/_decoder_single_.md +++ b/docs/util-rlp/modules/_decoder_single_.md @@ -8,7 +8,7 @@ ▸ **decodeSingle**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/single.ts#L7)* +*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/single.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_string_.html b/docs/util-rlp/modules/_decoder_string_.html index 3f4b030ef..358c6deb1 100644 --- a/docs/util-rlp/modules/_decoder_string_.html +++ b/docs/util-rlp/modules/_decoder_string_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

decodeString

▸ decodeString(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/string.ts:9

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

decodeString

▸ decodeString(decode: DecodeFunc, input: Uint8Array): DecodeOutput

Defined in decoder/string.ts:9

Parameters:

Name Type
decode DecodeFunc
input Uint8Array

Returns: DecodeOutput

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_string_.md b/docs/util-rlp/modules/_decoder_string_.md index c1163c21a..f8e4363a5 100644 --- a/docs/util-rlp/modules/_decoder_string_.md +++ b/docs/util-rlp/modules/_decoder_string_.md @@ -8,7 +8,7 @@ ▸ **decodeString**(decode: *[DecodeFunc](_decoder_types_.md#decodefunc)*, input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) -*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/string.ts#L9)* +*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/string.ts#L9)* **Parameters:** diff --git a/docs/util-rlp/modules/_decoder_types_.html b/docs/util-rlp/modules/_decoder_types_.html index eea812f55..34fe24590 100644 --- a/docs/util-rlp/modules/_decoder_types_.html +++ b/docs/util-rlp/modules/_decoder_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

DecodeFunc

Ƭ DecodeFunc: function

Defined in decoder/types.ts:10

Type declaration

▸(input: Uint8Array): DecodeOutput

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

DecodeOutput

Ƭ DecodeOutput: object

Defined in decoder/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

DecodeFunc

Ƭ DecodeFunc: function

Defined in decoder/types.ts:10

Type declaration

▸(input: Uint8Array): DecodeOutput

Parameters:

Name Type
input Uint8Array

Returns: DecodeOutput

DecodeOutput

Ƭ DecodeOutput: object

Defined in decoder/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_decoder_types_.md b/docs/util-rlp/modules/_decoder_types_.md index b4273c8e3..6da1b372a 100644 --- a/docs/util-rlp/modules/_decoder_types_.md +++ b/docs/util-rlp/modules/_decoder_types_.md @@ -8,7 +8,7 @@ **Ƭ DecodeFunc**: *`function`* -*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/types.ts#L10)* +*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L10)* #### Type declaration ▸(input: *`Uint8Array`*): [DecodeOutput](_decoder_types_.md#decodeoutput) @@ -28,7 +28,7 @@ ___ **Ƭ DecodeOutput**: *`object`* -*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/decoder/types.ts#L5)* +*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/decoder/types.ts#L5)* #### Type declaration diff --git a/docs/util-rlp/modules/_encode_.html b/docs/util-rlp/modules/_encode_.html index c1fdadcd5..f7eb499c4 100644 --- a/docs/util-rlp/modules/_encode_.html +++ b/docs/util-rlp/modules/_encode_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util-rlp/modules/_encoder_array_.html b/docs/util-rlp/modules/_encoder_array_.html index d1339631e..bce44d88c 100644 --- a/docs/util-rlp/modules/_encoder_array_.html +++ b/docs/util-rlp/modules/_encoder_array_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeArray

▸ encodeArray(encoder: EncodeFunc, input: any): Uint8Array

Defined in encoder/array.ts:11

Parameters:

Name Type
encoder EncodeFunc
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeArray

▸ encodeArray(encoder: EncodeFunc, input: any): Uint8Array

Defined in encoder/array.ts:11

Parameters:

Name Type
encoder EncodeFunc
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_encoder_array_.md b/docs/util-rlp/modules/_encoder_array_.md index 1d280ff63..05e80ce8c 100644 --- a/docs/util-rlp/modules/_encoder_array_.md +++ b/docs/util-rlp/modules/_encoder_array_.md @@ -8,7 +8,7 @@ ▸ **encodeArray**(encoder: *[EncodeFunc](_encoder_types_.md#encodefunc)*, input: *`any`*): `Uint8Array` -*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/array.ts#L11)* +*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/array.ts#L11)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_length_.html b/docs/util-rlp/modules/_encoder_length_.html index 65aa71630..b33d19193 100644 --- a/docs/util-rlp/modules/_encoder_length_.html +++ b/docs/util-rlp/modules/_encoder_length_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeLength

▸ encodeLength(length: number, offset: number): Uint8Array

Defined in encoder/length.ts:7

Parameters:

Name Type
length number
offset number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeLength

▸ encodeLength(length: number, offset: number): Uint8Array

Defined in encoder/length.ts:7

Parameters:

Name Type
length number
offset number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_encoder_length_.md b/docs/util-rlp/modules/_encoder_length_.md index 1505ce782..5658d6c6b 100644 --- a/docs/util-rlp/modules/_encoder_length_.md +++ b/docs/util-rlp/modules/_encoder_length_.md @@ -8,7 +8,7 @@ ▸ **encodeLength**(length: *`number`*, offset: *`number`*): `Uint8Array` -*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/length.ts#L7)* +*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/length.ts#L7)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_tou8a_.html b/docs/util-rlp/modules/_encoder_tou8a_.html index 29a1961b0..c72a9af22 100644 --- a/docs/util-rlp/modules/_encoder_tou8a_.html +++ b/docs/util-rlp/modules/_encoder_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

toU8a

▸ toU8a(value?: any): Uint8Array

Defined in encoder/toU8a.ts:39

Parameters:

Name Type
Optional value any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

toU8a

▸ toU8a(value?: any): Uint8Array

Defined in encoder/toU8a.ts:39

Parameters:

Name Type
Optional value any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_encoder_tou8a_.md b/docs/util-rlp/modules/_encoder_tou8a_.md index 6893ef808..7079eac84 100644 --- a/docs/util-rlp/modules/_encoder_tou8a_.md +++ b/docs/util-rlp/modules/_encoder_tou8a_.md @@ -8,7 +8,7 @@ ▸ **toU8a**(value?: *`any`*): `Uint8Array` -*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/toU8a.ts#L39)* +*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/toU8a.ts#L39)* **Parameters:** diff --git a/docs/util-rlp/modules/_encoder_types_.html b/docs/util-rlp/modules/_encoder_types_.html index 43df5734f..4b7b94c39 100644 --- a/docs/util-rlp/modules/_encoder_types_.html +++ b/docs/util-rlp/modules/_encoder_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

EncodeFunc

Ƭ EncodeFunc: function

Defined in encoder/types.ts:5

Type declaration

▸(input: any): Uint8Array

Parameters:

Name Type
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

EncodeFunc

Ƭ EncodeFunc: function

Defined in encoder/types.ts:5

Type declaration

▸(input: any): Uint8Array

Parameters:

Name Type
input any

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_encoder_types_.md b/docs/util-rlp/modules/_encoder_types_.md index 7470554e6..b6602b922 100644 --- a/docs/util-rlp/modules/_encoder_types_.md +++ b/docs/util-rlp/modules/_encoder_types_.md @@ -8,7 +8,7 @@ **Ƭ EncodeFunc**: *`function`* -*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/types.ts#L5)* +*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/types.ts#L5)* #### Type declaration ▸(input: *`any`*): `Uint8Array` diff --git a/docs/util-rlp/modules/_encoder_u8a_.html b/docs/util-rlp/modules/_encoder_u8a_.html index 99a7f384c..ceeeae60c 100644 --- a/docs/util-rlp/modules/_encoder_u8a_.html +++ b/docs/util-rlp/modules/_encoder_u8a_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

encodeU8a

▸ encodeU8a(encoder: EncodeFunc, input: Uint8Array): Uint8Array

Defined in encoder/u8a.ts:11

Parameters:

Name Type
encoder EncodeFunc
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

encodeU8a

▸ encodeU8a(encoder: EncodeFunc, input: Uint8Array): Uint8Array

Defined in encoder/u8a.ts:11

Parameters:

Name Type
encoder EncodeFunc
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util-rlp/modules/_encoder_u8a_.md b/docs/util-rlp/modules/_encoder_u8a_.md index 4d608666f..ae3a06ddb 100644 --- a/docs/util-rlp/modules/_encoder_u8a_.md +++ b/docs/util-rlp/modules/_encoder_u8a_.md @@ -8,7 +8,7 @@ ▸ **encodeU8a**(encoder: *[EncodeFunc](_encoder_types_.md#encodefunc)*, input: *`Uint8Array`*): `Uint8Array` -*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util-rlp/src/encoder/u8a.ts#L11)* +*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util-rlp/src/encoder/u8a.ts#L11)* **Parameters:** diff --git a/docs/util/SUMMARY.html b/docs/util/SUMMARY.html index d1c99f51f..2fa916e8b 100644 --- a/docs/util/SUMMARY.html +++ b/docs/util/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/26/2019, 11:08:42 AM
- +
Last Updated: 2/26/2019, 11:08:42 AM
+ diff --git a/docs/util/classes/_ext_error_.exterror.html b/docs/util/classes/_ext_error_.exterror.html index f90294636..37a2a19c4 100644 --- a/docs/util/classes/_ext_error_.exterror.html +++ b/docs/util/classes/_ext_error_.exterror.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

name: ExtError

summary: Extension to the basic JS Error.

description: The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal stack, message, the numeric code and data (any types) parameters are available on the object.

example:

const { ExtError } from '@polkadot/util');
+

name: ExtError

summary: Extension to the basic JS Error.

description: The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal stack, message, the numeric code and data (any types) parameters are available on the object.

example:

const { ExtError } from '@polkadot/util');
 
 throw new ExtError('some message', ExtError.CODES.METHOD_NOT_FOUND); // => error.code = -32601
-
1
2
3

Hierarchy

Error

↳ ExtError

Implements

Constructors

constructor

⊕ new ExtError(message?: string, code?: number, data?: any): ExtError

Defined in ext/error.ts:43

Parameters:

Name Type Default value
Default value message string ""
Default value code number UNKNOWN
Optional data any -

Returns: ExtError

Properties

code

● code: number

Implementation of ExtErrorInterface.code

Defined in ext/error.ts:35

data

● data: any

Implementation of ExtErrorInterface.data

Defined in ext/error.ts:37

message

● message: string

Implementation of ExtErrorInterface.message

Overrides Error.message

Defined in ext/error.ts:39

name

● name: string

Overrides Error.name

Defined in ext/error.ts:41

stack

● stack: string

Implementation of ExtErrorInterface.stack

Overrides Error.stack

Defined in ext/error.ts:43

<Static> Error

● Error: ErrorConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984

Object literals

<Static> CODES

CODES: object

Defined in ext/error.ts:60

ASSERT

● ASSERT: number = -90009

Defined in ext/error.ts:61

INVALID_JSONRPC

● INVALID_JSONRPC: number = -99998

Defined in ext/error.ts:63

METHOD_NOT_FOUND

● METHOD_NOT_FOUND: number = -32601

Defined in ext/error.ts:64

UNKNOWN

● UNKNOWN: number

Defined in ext/error.ts:62

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Hierarchy

Error

↳ ExtError

Implements

Constructors

constructor

⊕ new ExtError(message?: string, code?: number, data?: any): ExtError

Defined in ext/error.ts:43

Parameters:

Name Type Default value
Default value message string ""
Default value code number UNKNOWN
Optional data any -

Returns: ExtError

Properties

code

● code: number

Implementation of ExtErrorInterface.code

Defined in ext/error.ts:35

data

● data: any

Implementation of ExtErrorInterface.data

Defined in ext/error.ts:37

message

● message: string

Implementation of ExtErrorInterface.message

Overrides Error.message

Defined in ext/error.ts:39

name

● name: string

Overrides Error.name

Defined in ext/error.ts:41

stack

● stack: string

Implementation of ExtErrorInterface.stack

Overrides Error.stack

Defined in ext/error.ts:43

<Static> Error

● Error: ErrorConstructor

Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:984

Object literals

<Static> CODES

CODES: object

Defined in ext/error.ts:60

ASSERT

● ASSERT: number = -90009

Defined in ext/error.ts:61

INVALID_JSONRPC

● INVALID_JSONRPC: number = -99998

Defined in ext/error.ts:63

METHOD_NOT_FOUND

● METHOD_NOT_FOUND: number = -32601

Defined in ext/error.ts:64

UNKNOWN

● UNKNOWN: number

Defined in ext/error.ts:62

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/classes/_ext_error_.exterror.md b/docs/util/classes/_ext_error_.exterror.md index 41227c401..32ddb0fdb 100644 --- a/docs/util/classes/_ext_error_.exterror.md +++ b/docs/util/classes/_ext_error_.exterror.md @@ -32,7 +32,7 @@ throw new ExtError('some message', ExtError.CODES.METHOD_NOT_FOUND); // => error ⊕ **new ExtError**(message?: *`string`*, code?: *`number`*, data?: *`any`*): [ExtError](_ext_error_.exterror.md) -*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43)* **Parameters:** @@ -56,7 +56,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[code](../interfaces/_types_.exterrorinterface.md#code)* -*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L35)* +*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L35)* ___ @@ -67,7 +67,7 @@ ___ *Implementation of [ExtErrorInterface](../interfaces/_types_.exterrorinterface.md).[data](../interfaces/_types_.exterrorinterface.md#data)* -*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L37)* +*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L37)* ___ @@ -80,7 +80,7 @@ ___ *Overrides Error.message* -*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L39)* +*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L39)* ___ @@ -91,7 +91,7 @@ ___ *Overrides Error.name* -*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L41)* +*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L41)* ___ @@ -104,7 +104,7 @@ ___ *Overrides Error.stack* -*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L43)* ___ @@ -125,7 +125,7 @@ ___ **CODES**: *`object`* -*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L60)* +*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L60)* @@ -133,7 +133,7 @@ ___ **● ASSERT**: *`number`* = -90009 -*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L61)* +*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L61)* ___ @@ -142,7 +142,7 @@ ___ **● INVALID_JSONRPC**: *`number`* = -99998 -*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L63)* +*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L63)* ___ @@ -151,7 +151,7 @@ ___ **● METHOD_NOT_FOUND**: *`number`* = -32601 -*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L64)* +*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L64)* ___ @@ -160,7 +160,7 @@ ___ **● UNKNOWN**: *`number`* -*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/ext/error.ts#L62)* +*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/ext/error.ts#L62)* ___ diff --git a/docs/util/index.html b/docs/util/index.html index 1a6f0433e..66ccca299 100644 --- a/docs/util/index.html +++ b/docs/util/index.html @@ -7,7 +7,7 @@ - + @@ -15,17 +15,17 @@ GitHub

@polkadot/util

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util
+

@polkadot/util

Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

Usage

Installation -

yarn add @polkadot/util
1

Functions can be imported directly from the package, e.g.

import { isHex } from '@polkadot/util';
1

Utilities

Utilities

Last Updated: 2/26/2019, 11:08:42 AM

← - /util-crypto/ + @polkadot/util-crypto →

- + diff --git a/docs/util/interfaces/_types_.exterrorinterface.html b/docs/util/interfaces/_types_.exterrorinterface.html index ee1637803..f433a841b 100644 --- a/docs/util/interfaces/_types_.exterrorinterface.html +++ b/docs/util/interfaces/_types_.exterrorinterface.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

ExtErrorInterface

Implemented by

Properties

code

● code: number

Defined in types.ts:6

data

● data: any

Defined in types.ts:7

message

● message: string

Defined in types.ts:8

stack

● stack: string

Defined in types.ts:9

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

ExtErrorInterface

Implemented by

Properties

code

● code: number

Defined in types.ts:6

data

● data: any

Defined in types.ts:7

message

● message: string

Defined in types.ts:8

stack

● stack: string

Defined in types.ts:9

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/interfaces/_types_.exterrorinterface.md b/docs/util/interfaces/_types_.exterrorinterface.md index dafe0140d..a8fe89f0f 100644 --- a/docs/util/interfaces/_types_.exterrorinterface.md +++ b/docs/util/interfaces/_types_.exterrorinterface.md @@ -16,7 +16,7 @@ **● code**: *`number`* -*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L6)* ___ @@ -25,7 +25,7 @@ ___ **● data**: *`any`* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L7)* ___ @@ -34,7 +34,7 @@ ___ **● message**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L8)* ___ @@ -43,7 +43,7 @@ ___ **● stack**: *`string`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L9)* ___ diff --git a/docs/util/interfaces/_types_.tobnoptions.html b/docs/util/interfaces/_types_.tobnoptions.html index c418c3a34..2c2acb23a 100644 --- a/docs/util/interfaces/_types_.tobnoptions.html +++ b/docs/util/interfaces/_types_.tobnoptions.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Hierarchy

ToBnOptions

Properties

<Optional> isLe

● isLe: undefined | false | true

Defined in types.ts:24

<Optional> isNegative

● isNegative: undefined | false | true

Defined in types.ts:25

Last Updated: 2/26/2019, 11:08:42 AM
- +

Hierarchy

ToBnOptions

Properties

<Optional> isLe

● isLe: undefined | false | true

Defined in types.ts:24

<Optional> isNegative

● isNegative: undefined | false | true

Defined in types.ts:25

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/interfaces/_types_.tobnoptions.md b/docs/util/interfaces/_types_.tobnoptions.md index 27931c2e9..ba8b258f5 100644 --- a/docs/util/interfaces/_types_.tobnoptions.md +++ b/docs/util/interfaces/_types_.tobnoptions.md @@ -12,7 +12,7 @@ **● isLe**: *`undefined` \| `false` \| `true`* -*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L24)* ___ @@ -21,7 +21,7 @@ ___ **● isNegative**: *`undefined` \| `false` \| `true`* -*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L25)* ___ diff --git a/docs/util/modules/_array_filter_.html b/docs/util/modules/_array_filter_.html index c700facab..58c8dd9c9 100644 --- a/docs/util/modules/_array_filter_.html +++ b/docs/util/modules/_array_filter_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

arrayFilter

▸ arrayFilter(array: Array<any>, allowNulls?: boolean): Array<any>

Defined in array/filter.ts:23

name: arrayFilter

summary: Filters undefined and (optionally) null values from an array

description: Returns a new array with all undefined values removed. Optionally, when allowNulls = false, it removes the null values as well

example:

import { arrayFilter } from '@polkadot/util';
+

Functions

arrayFilter

▸ arrayFilter(array: Array<any>, allowNulls?: boolean): Array<any>

Defined in array/filter.ts:23

name: arrayFilter

summary: Filters undefined and (optionally) null values from an array

description: Returns a new array with all undefined values removed. Optionally, when allowNulls = false, it removes the null values as well

example:

import { arrayFilter } from '@polkadot/util';
 
 arrayFilter([0, void 0, true, null, false, '']); // [0, true, null, false, '']
 arrayFilter([0, void 0, true, null, false, ''], false); // [0, true, false, '']
-
1
2
3
4

Parameters:

Name Type Default value
array Array<any> -
Default value allowNulls boolean true

Returns: Array<any>

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
array Array<any> -
Default value allowNulls boolean true

Returns: Array<any>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_array_filter_.md b/docs/util/modules/_array_filter_.md index b2dab1c35..d5b101163 100644 --- a/docs/util/modules/_array_filter_.md +++ b/docs/util/modules/_array_filter_.md @@ -8,7 +8,7 @@ ▸ **arrayFilter**(array: *`Array`<`any`>*, allowNulls?: *`boolean`*): `Array`<`any`> -*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/array/filter.ts#L23)* +*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/array/filter.ts#L23)* *__name__*: arrayFilter diff --git a/docs/util/modules/_assert_.html b/docs/util/modules/_assert_.html index 488c76a58..e65b69d62 100644 --- a/docs/util/modules/_assert_.html +++ b/docs/util/modules/_assert_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

assert

▸ assert<T>(test: Falsy | T, message: string | MessageFn, code?: number, data?: any): boolean

Defined in assert.ts:28

name: assert

summary: Checks for a valid test, if not ExtError is thrown.

description: Checks that test is a truthy value. If value is falsy (null, undefined, false, ...), it throws an ExtError with the supplied message and an optional code and data. When test passes, true is returned.

example:

const { assert } from '@polkadot/util';
+

Functions

assert

▸ assert<T>(test: Falsy | T, message: string | MessageFn, code?: number, data?: any): boolean

Defined in assert.ts:28

name: assert

summary: Checks for a valid test, if not ExtError is thrown.

description: Checks that test is a truthy value. If value is falsy (null, undefined, false, ...), it throws an ExtError with the supplied message and an optional code and data. When test passes, true is returned.

example:

const { assert } from '@polkadot/util';
 
 assert(true, 'True should be true'); // true returned
 assert(false, 'False should not be true'); // ExtError thrown
 assert(false, () => 'message'); // ExtError with 'message'
-
1
2
3
4
5

Type parameters:

T

Parameters:

Name Type Default value
test Falsy | T -
message string | MessageFn -
Default value code number ExtError.CODES.ASSERT
Optional data any -

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Type parameters:

T

Parameters:

Name Type Default value
test Falsy | T -
message string | MessageFn -
Default value code number ExtError.CODES.ASSERT
Optional data any -

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_assert_.md b/docs/util/modules/_assert_.md index ed9eaf111..d16a0779c 100644 --- a/docs/util/modules/_assert_.md +++ b/docs/util/modules/_assert_.md @@ -8,7 +8,7 @@ ▸ **assert**<`T`>(test: *`Falsy` \| `T`*, message: *`string` \| `MessageFn`*, code?: *`number`*, data?: *`any`*): `boolean` -*Defined in [assert.ts:28](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/assert.ts#L28)* +*Defined in [assert.ts:28](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/assert.ts#L28)* *__name__*: assert diff --git a/docs/util/modules/_bn_fromhex_.html b/docs/util/modules/_bn_fromhex_.html index d62a852ed..c15a69303 100644 --- a/docs/util/modules/_bn_fromhex_.html +++ b/docs/util/modules/_bn_fromhex_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_bn_tobn_.html b/docs/util/modules/_bn_tobn_.html index f388f1f87..17bac4499 100644 --- a/docs/util/modules/_bn_tobn_.html +++ b/docs/util/modules/_bn_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

bnToBn

▸ bnToBn(value?: BN | number | null): BN

Defined in bn/toBn.ts:23

name: bnToBn

summary: Creates a BN value from a BN.js bignumber or number input.

description: null inputs returns a 0x0 result, BN values returns the value, numnbers returns a BN representation.

example:

import BN from 'bn.js';
+

Functions

bnToBn

▸ bnToBn(value?: BN | number | null): BN

Defined in bn/toBn.ts:23

name: bnToBn

summary: Creates a BN value from a BN.js bignumber or number input.

description: null inputs returns a 0x0 result, BN values returns the value, numnbers returns a BN representation.

example:

import BN from 'bn.js';
 import { bnToBn } from '@polkadot/util';
 
 bnToBn(0x1234); // => BN(0x1234)
 bnToBn(new BN(0x1234)); // => BN(0x1234)
-
1
2
3
4
5

Parameters:

Name Type
Optional value BN | number | null

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type
Optional value BN | number | null

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_bn_tobn_.md b/docs/util/modules/_bn_tobn_.md index 2fc0a347b..48ee1cc09 100644 --- a/docs/util/modules/_bn_tobn_.md +++ b/docs/util/modules/_bn_tobn_.md @@ -8,7 +8,7 @@ ▸ **bnToBn**(value?: *`BN` \| `number` \| `null`*): `BN` -*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toBn.ts#L23)* +*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toBn.ts#L23)* *__name__*: bnToBn diff --git a/docs/util/modules/_bn_tohex_.html b/docs/util/modules/_bn_tohex_.html index 9f54828e8..c48a5bb08 100644 --- a/docs/util/modules/_bn_tohex_.html +++ b/docs/util/modules/_bn_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

bnToHex

▸ bnToHex(value?: BN | number | null, options?: number | Options): string

Defined in bn/toHex.ts:33

name: bnToHex

summary: Creates a hex value from a BN.js bignumber object.

description: null inputs returns a 0x result, BN values return the actual value as a 0x prefixed hex value. Anything that is not a BN object throws an error. With bitLength set, it fixes the number to the specified length.

example:

import BN from 'bn.js';
+

Functions

bnToHex

▸ bnToHex(value?: BN | number | null, options?: number | Options): string

Defined in bn/toHex.ts:33

name: bnToHex

summary: Creates a hex value from a BN.js bignumber object.

description: null inputs returns a 0x result, BN values return the actual value as a 0x prefixed hex value. Anything that is not a BN object throws an error. With bitLength set, it fixes the number to the specified length.

example:

import BN from 'bn.js';
 import { bnToHex } from '@polkadot/util';
 
 bnToHex(new BN(0x123456)); // => '0x123456'
-
1
2
3
4

Parameters:

Name Type Default value
Optional value BN | number | null -
Default value options number | Options { bitLength: -1, isLe: false, isNegative: false }

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional value BN | number | null -
Default value options number | Options { bitLength: -1, isLe: false, isNegative: false }

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_bn_tohex_.md b/docs/util/modules/_bn_tohex_.md index 949f23d40..503677ff6 100644 --- a/docs/util/modules/_bn_tohex_.md +++ b/docs/util/modules/_bn_tohex_.md @@ -8,7 +8,7 @@ ▸ **bnToHex**(value?: *`BN` \| `number` \| `null`*, options?: *`number` \| `Options`*): `string` -*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toHex.ts#L33)* +*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toHex.ts#L33)* *__name__*: bnToHex diff --git a/docs/util/modules/_bn_tou8a_.html b/docs/util/modules/_bn_tou8a_.html index 651a9f74a..6127790b9 100644 --- a/docs/util/modules/_bn_tou8a_.html +++ b/docs/util/modules/_bn_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

bnToU8a

▸ bnToU8a(value: BN | number | null, options?: Options): Uint8Array

▸ bnToU8a(value: BN | number | null, bitLength?: undefined | number, isLe?: undefined | false | true): Uint8Array

Defined in bn/toU8a.ts:29

name: bnToU8a

summary: Creates a Uint8Array object from a BN.

description: null/undefined/NaN inputs returns an empty Uint8Array result. BN input values return the actual bytes value converted to a Uint8Array. Optionally convert using little-endian format if isLE is set.

example:

import { bnToU8a } from '@polkadot/util';
+

Functions

bnToU8a

▸ bnToU8a(value: BN | number | null, options?: Options): Uint8Array

▸ bnToU8a(value: BN | number | null, bitLength?: undefined | number, isLe?: undefined | false | true): Uint8Array

Defined in bn/toU8a.ts:29

name: bnToU8a

summary: Creates a Uint8Array object from a BN.

description: null/undefined/NaN inputs returns an empty Uint8Array result. BN input values return the actual bytes value converted to a Uint8Array. Optionally convert using little-endian format if isLE is set.

example:

import { bnToU8a } from '@polkadot/util';
 
 bnToU8a(new BN(0x1234)); // => [0x12, 0x34]
-
1
2
3

Parameters:

Name Type
value BN | number | null
Optional options Options

Returns: Uint8Array

Defined in bn/toU8a.ts:30

Parameters:

Name Type
value BN | number | null
Optional bitLength undefined | number
Optional isLe undefined | false | true

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value BN | number | null
Optional options Options

Returns: Uint8Array

Defined in bn/toU8a.ts:30

Parameters:

Name Type
value BN | number | null
Optional bitLength undefined | number
Optional isLe undefined | false | true

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_bn_tou8a_.md b/docs/util/modules/_bn_tou8a_.md index 5fe5a5e11..d913dbcec 100644 --- a/docs/util/modules/_bn_tou8a_.md +++ b/docs/util/modules/_bn_tou8a_.md @@ -10,7 +10,7 @@ ▸ **bnToU8a**(value: *`BN` \| `number` \| `null`*, bitLength?: *`undefined` \| `number`*, isLe?: *`undefined` \| `false` \| `true`*): `Uint8Array` -*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toU8a.ts#L29)* +*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L29)* *__name__*: bnToU8a @@ -35,7 +35,7 @@ bnToU8a(new BN(0x1234)); // => [0x12, 0x34] **Returns:** `Uint8Array` -*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/bn/toU8a.ts#L30)* +*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/bn/toU8a.ts#L30)* **Parameters:** diff --git a/docs/util/modules/_buffer_tou8a_.html b/docs/util/modules/_buffer_tou8a_.html index 847fc83b0..e542f0737 100644 --- a/docs/util/modules/_buffer_tou8a_.html +++ b/docs/util/modules/_buffer_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

bufferToU8a

▸ bufferToU8a(buffer?: Buffer | number[] | null): Uint8Array

Defined in buffer/toU8a.ts:19

name: bufferToU8a

summary: Creates a Uint8Array value from a Buffer object.

description: null inputs returns an empty result, Buffer values return the actual value as a Uint8Array. Anything that is not a Buffer object throws an error.

example:

import { bufferToU8a } from '@polkadot/util';
+

Functions

bufferToU8a

▸ bufferToU8a(buffer?: Buffer | number[] | null): Uint8Array

Defined in buffer/toU8a.ts:19

name: bufferToU8a

summary: Creates a Uint8Array value from a Buffer object.

description: null inputs returns an empty result, Buffer values return the actual value as a Uint8Array. Anything that is not a Buffer object throws an error.

example:

import { bufferToU8a } from '@polkadot/util';
 
 bufferToU8a(Buffer.from([1, 2, 3]));
-
1
2
3

Parameters:

Name Type
Optional buffer Buffer | number[] | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional buffer Buffer | number[] | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_buffer_tou8a_.md b/docs/util/modules/_buffer_tou8a_.md index faf659c2a..e78476563 100644 --- a/docs/util/modules/_buffer_tou8a_.md +++ b/docs/util/modules/_buffer_tou8a_.md @@ -8,7 +8,7 @@ ▸ **bufferToU8a**(buffer?: *`Buffer` \| `number`[] \| `null`*): `Uint8Array` -*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/buffer/toU8a.ts#L19)* +*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/buffer/toU8a.ts#L19)* *__name__*: bufferToU8a diff --git a/docs/util/modules/_compact_addlength_.html b/docs/util/modules/_compact_addlength_.html index 805295f25..e5eb2c80d 100644 --- a/docs/util/modules/_compact_addlength_.html +++ b/docs/util/modules/_compact_addlength_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactAddLength

▸ compactAddLength(input: Uint8Array): Uint8Array

Defined in compact/addLength.ts:20

name: compactAddLength

description: Adds a length prefix to the input value

example:

import { compactAddLength } from '@polkadot/util';
+

Functions

compactAddLength

▸ compactAddLength(input: Uint8Array): Uint8Array

Defined in compact/addLength.ts:20

name: compactAddLength

description: Adds a length prefix to the input value

example:

import { compactAddLength } from '@polkadot/util';
 
 console.log(compactAddLength(new Uint8Array([0xde, 0xad, 0xbe, 0xef]))); // Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef])
-
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_addlength_.md b/docs/util/modules/_compact_addlength_.md index 4ab65047d..0a1a12cab 100644 --- a/docs/util/modules/_compact_addlength_.md +++ b/docs/util/modules/_compact_addlength_.md @@ -8,7 +8,7 @@ ▸ **compactAddLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/addLength.ts#L20)* +*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/addLength.ts#L20)* *__name__*: compactAddLength diff --git a/docs/util/modules/_compact_defaults_.html b/docs/util/modules/_compact_defaults_.html index 3600b1ad1..b1a13e13d 100644 --- a/docs/util/modules/_compact_defaults_.html +++ b/docs/util/modules/_compact_defaults_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Variables

<Const> DEFAULT_BITLENGTH

● DEFAULT_BITLENGTH: BitLength = 32

Defined in compact/defaults.ts:7

Last Updated: 2/26/2019, 11:08:42 AM
- +

Variables

<Const> DEFAULT_BITLENGTH

● DEFAULT_BITLENGTH: BitLength = 32

Defined in compact/defaults.ts:7

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_defaults_.md b/docs/util/modules/_compact_defaults_.md index fdf1cfd54..9f8f5fd3d 100644 --- a/docs/util/modules/_compact_defaults_.md +++ b/docs/util/modules/_compact_defaults_.md @@ -8,7 +8,7 @@ **● DEFAULT_BITLENGTH**: *[BitLength](_compact_types_.md#bitlength)* = 32 -*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/defaults.ts#L7)* +*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/defaults.ts#L7)* ___ diff --git a/docs/util/modules/_compact_fromu8a_.html b/docs/util/modules/_compact_fromu8a_.html index 035aac662..fbdee961c 100644 --- a/docs/util/modules/_compact_fromu8a_.html +++ b/docs/util/modules/_compact_fromu8a_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

compactFromU8a

▸ compactFromU8a(_input: Uint8Array | string, bitLength?: BitLength): [number, BN]

Defined in compact/fromU8a.ts:26

name: compactFromU8a

description: Retrievs the offset and encoded length from a compact-prefixed value

example:

import { compactFromU8a } from '@polkadot/util';
+

Functions

compactFromU8a

▸ compactFromU8a(_input: Uint8Array | string, bitLength?: BitLength): [number, BN]

Defined in compact/fromU8a.ts:26

name: compactFromU8a

description: Retrievs the offset and encoded length from a compact-prefixed value

example:

import { compactFromU8a } from '@polkadot/util';
 
 const [offset, length] = compactFromU8a(new Uint8Array([254, 255, 3, 0]), 32));
 
 console.log('value offset=', offset, 'length=', length); // 4, 0xffff
-
1
2
3
4
5

Parameters:

Name Type Default value
_input Uint8Array | string -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, BN]

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
_input Uint8Array | string -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, BN]

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_fromu8a_.md b/docs/util/modules/_compact_fromu8a_.md index 40cf00b71..b7466486a 100644 --- a/docs/util/modules/_compact_fromu8a_.md +++ b/docs/util/modules/_compact_fromu8a_.md @@ -8,7 +8,7 @@ ▸ **compactFromU8a**(_input: *`Uint8Array` \| `string`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `BN`] -*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/fromU8a.ts#L26)* +*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/fromU8a.ts#L26)* *__name__*: compactFromU8a diff --git a/docs/util/modules/_compact_striplength_.html b/docs/util/modules/_compact_striplength_.html index 67bd4f45e..e3fc8ca70 100644 --- a/docs/util/modules/_compact_striplength_.html +++ b/docs/util/modules/_compact_striplength_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactStripLength

▸ compactStripLength(input: Uint8Array, bitLength?: BitLength): [number, Uint8Array]

Defined in compact/stripLength.ts:22

name: compactStripLength

description: Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length

example:

import { compactStripLength } from '@polkadot/util';
+

Functions

compactStripLength

▸ compactStripLength(input: Uint8Array, bitLength?: BitLength): [number, Uint8Array]

Defined in compact/stripLength.ts:22

name: compactStripLength

description: Removes the length prefix, returning both the total length (including the value + compact encoding) and the decoded value with the correct length

example:

import { compactStripLength } from '@polkadot/util';
 
 console.log(compactStripLength(new Uint8Array([2 << 2, 0xde, 0xad]))); // [2, Uint8Array[0xde, 0xad]]
-
1
2
3

Parameters:

Name Type Default value
input Uint8Array -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, Uint8Array]

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
input Uint8Array -
Default value bitLength BitLength DEFAULT_BITLENGTH

Returns: [number, Uint8Array]

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_striplength_.md b/docs/util/modules/_compact_striplength_.md index 3903bbbf8..dd5b92456 100644 --- a/docs/util/modules/_compact_striplength_.md +++ b/docs/util/modules/_compact_striplength_.md @@ -8,7 +8,7 @@ ▸ **compactStripLength**(input: *`Uint8Array`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `Uint8Array`] -*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/stripLength.ts#L22)* +*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/stripLength.ts#L22)* *__name__*: compactStripLength diff --git a/docs/util/modules/_compact_tou8a_.html b/docs/util/modules/_compact_tou8a_.html index 7cb25cc81..4f9031583 100644 --- a/docs/util/modules/_compact_tou8a_.html +++ b/docs/util/modules/_compact_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

compactToU8a

▸ compactToU8a(_value: BN | number): Uint8Array

Defined in compact/toU8a.ts:27

name: compactToU8a

description: Encodes a number into a compact representation

example:

import { compactToU8a } from '@polkadot/util';
+

Functions

compactToU8a

▸ compactToU8a(_value: BN | number): Uint8Array

Defined in compact/toU8a.ts:27

name: compactToU8a

description: Encodes a number into a compact representation

example:

import { compactToU8a } from '@polkadot/util';
 
 console.log(compactToU8a(511, 32)); // Uint8Array([0b11111101, 0b00000111])
-
1
2
3

Parameters:

Name Type
_value BN | number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
_value BN | number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_tou8a_.md b/docs/util/modules/_compact_tou8a_.md index f7c21e93d..9e6b0a520 100644 --- a/docs/util/modules/_compact_tou8a_.md +++ b/docs/util/modules/_compact_tou8a_.md @@ -8,7 +8,7 @@ ▸ **compactToU8a**(_value: *`BN` \| `number`*): `Uint8Array` -*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/toU8a.ts#L27)* +*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/toU8a.ts#L27)* *__name__*: compactToU8a diff --git a/docs/util/modules/_compact_types_.html b/docs/util/modules/_compact_types_.html index 274a3c868..e3f46ba6c 100644 --- a/docs/util/modules/_compact_types_.html +++ b/docs/util/modules/_compact_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Type aliases

BitLength

Ƭ BitLength: 8 | 16 | 32 | 64 | 128 | 256

Defined in compact/types.ts:5

Last Updated: 2/26/2019, 11:08:42 AM
- +

Type aliases

BitLength

Ƭ BitLength: 8 | 16 | 32 | 64 | 128 | 256

Defined in compact/types.ts:5

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_compact_types_.md b/docs/util/modules/_compact_types_.md index afd5f2853..594d6ea96 100644 --- a/docs/util/modules/_compact_types_.md +++ b/docs/util/modules/_compact_types_.md @@ -8,7 +8,7 @@ **Ƭ BitLength**: *`8` \| `16` \| `32` \| `64` \| `128` \| `256`* -*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/compact/types.ts#L5)* +*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/compact/types.ts#L5)* ___ diff --git a/docs/util/modules/_ext_error_.html b/docs/util/modules/_ext_error_.html index 322756a87..48d956f29 100644 --- a/docs/util/modules/_ext_error_.html +++ b/docs/util/modules/_ext_error_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Classes

Last Updated: 2/13/2019, 4:33:49 PM
- +

Index

Classes

Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_hex_addprefix_.html b/docs/util/modules/_hex_addprefix_.html index 5d7ee07d8..056657cb1 100644 --- a/docs/util/modules/_hex_addprefix_.html +++ b/docs/util/modules/_hex_addprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexAddPrefix

▸ hexAddPrefix(value?: string | null): string

Defined in hex/addPrefix.ts:21

name: hexAddPrefix

summary: Adds the 0x prefix to string values.

description: Returns a 0x prefixed string from the input value. If the input is already prefixed, it is returned unchanged.

example:

import { hexAddPrefix } from '@polkadot/util';
+

Functions

hexAddPrefix

▸ hexAddPrefix(value?: string | null): string

Defined in hex/addPrefix.ts:21

name: hexAddPrefix

summary: Adds the 0x prefix to string values.

description: Returns a 0x prefixed string from the input value. If the input is already prefixed, it is returned unchanged.

example:

import { hexAddPrefix } from '@polkadot/util';
 
 console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_addprefix_.md b/docs/util/modules/_hex_addprefix_.md index 1586dcebe..300fcef83 100644 --- a/docs/util/modules/_hex_addprefix_.md +++ b/docs/util/modules/_hex_addprefix_.md @@ -8,7 +8,7 @@ ▸ **hexAddPrefix**(value?: *`string` \| `null`*): `string` -*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/addPrefix.ts#L21)* +*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/addPrefix.ts#L21)* *__name__*: hexAddPrefix diff --git a/docs/util/modules/_hex_fixlength_.html b/docs/util/modules/_hex_fixlength_.html index cd1604251..9043e6985 100644 --- a/docs/util/modules/_hex_fixlength_.html +++ b/docs/util/modules/_hex_fixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

hexFixLength

▸ hexFixLength(value: string, bitLength?: number, withPadding?: boolean): string

Defined in hex/fixLength.ts:24

name: hexFixLength

summary: Shifts a hex string to a specific bitLength

description: Returns a 0x prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When withPadding is set, shorter values are padded with 0.

example:

import { hexFixLength } from '@polkadot/util';
+

Functions

hexFixLength

▸ hexFixLength(value: string, bitLength?: number, withPadding?: boolean): string

Defined in hex/fixLength.ts:24

name: hexFixLength

summary: Shifts a hex string to a specific bitLength

description: Returns a 0x prefixed string with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length. Input values with less bits are returned as-is by default. When withPadding is set, shorter values are padded with 0.

example:

import { hexFixLength } from '@polkadot/util';
 
 console.log('fixed', hexFixLength('0x12', 16)); // => 0x12
 console.log('fixed', hexFixLength('0x12', 16, true)); // => 0x0012
 console.log('fixed', hexFixLength('0x0012', 8)); // => 0x12
-
1
2
3
4
5

Parameters:

Name Type Default value
value string -
Default value bitLength number -1
Default value withPadding boolean false

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
value string -
Default value bitLength number -1
Default value withPadding boolean false

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_fixlength_.md b/docs/util/modules/_hex_fixlength_.md index 7915036e4..3d880461d 100644 --- a/docs/util/modules/_hex_fixlength_.md +++ b/docs/util/modules/_hex_fixlength_.md @@ -8,7 +8,7 @@ ▸ **hexFixLength**(value: *`string`*, bitLength?: *`number`*, withPadding?: *`boolean`*): `string` -*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/fixLength.ts#L24)* +*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/fixLength.ts#L24)* *__name__*: hexFixLength diff --git a/docs/util/modules/_hex_hasprefix_.html b/docs/util/modules/_hex_hasprefix_.html index 9877874cc..0cf6b7bf5 100644 --- a/docs/util/modules/_hex_hasprefix_.html +++ b/docs/util/modules/_hex_hasprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexHasPrefix

▸ hexHasPrefix(value?: string | null): boolean

Defined in hex/hasPrefix.ts:21

name: hexHasPrefix

summary: Tests for the existence of a 0x prefix.

description: Checks for a valid hex input value and if the start matched 0x

example:

import { hexHasPrefix } from '@polkadot/util';
+

Functions

hexHasPrefix

▸ hexHasPrefix(value?: string | null): boolean

Defined in hex/hasPrefix.ts:21

name: hexHasPrefix

summary: Tests for the existence of a 0x prefix.

description: Checks for a valid hex input value and if the start matched 0x

example:

import { hexHasPrefix } from '@polkadot/util';
 
 console.log('has prefix', hexHasPrefix('0x1234')); // => true
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_hasprefix_.md b/docs/util/modules/_hex_hasprefix_.md index 4edd26477..207bce984 100644 --- a/docs/util/modules/_hex_hasprefix_.md +++ b/docs/util/modules/_hex_hasprefix_.md @@ -8,7 +8,7 @@ ▸ **hexHasPrefix**(value?: *`string` \| `null`*): `boolean` -*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/hasPrefix.ts#L21)* +*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/hasPrefix.ts#L21)* *__name__*: hexHasPrefix diff --git a/docs/util/modules/_hex_stripprefix_.html b/docs/util/modules/_hex_stripprefix_.html index 7e2797df9..ad6d767a0 100644 --- a/docs/util/modules/_hex_stripprefix_.html +++ b/docs/util/modules/_hex_stripprefix_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexStripPrefix

▸ hexStripPrefix(value?: string | null): string

Defined in hex/stripPrefix.ts:23

name: hexStripPrefix

summary: Strips any leading 0x prefix.

description: Tests for the existence of a 0x prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.

example:

import { hexStripPrefix } from '@polkadot/util';
+

Functions

hexStripPrefix

▸ hexStripPrefix(value?: string | null): string

Defined in hex/stripPrefix.ts:23

name: hexStripPrefix

summary: Strips any leading 0x prefix.

description: Tests for the existence of a 0x prefix, and returns the value without the prefix. Un-prefixed values are returned as-is.

example:

import { hexStripPrefix } from '@polkadot/util';
 
 console.log('stripped', hexStripPrefix('0x1234')); // => 1234
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_stripprefix_.md b/docs/util/modules/_hex_stripprefix_.md index cd9c7bf7f..da9bc243c 100644 --- a/docs/util/modules/_hex_stripprefix_.md +++ b/docs/util/modules/_hex_stripprefix_.md @@ -8,7 +8,7 @@ ▸ **hexStripPrefix**(value?: *`string` \| `null`*): `string` -*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/stripPrefix.ts#L23)* +*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/stripPrefix.ts#L23)* *__name__*: hexStripPrefix diff --git a/docs/util/modules/_hex_tobn_.html b/docs/util/modules/_hex_tobn_.html index 1c2dae876..82853f6be 100644 --- a/docs/util/modules/_hex_tobn_.html +++ b/docs/util/modules/_hex_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexToBn

▸ hexToBn(value?: string | number | null, options?: ToBnOptions | boolean): BN

Defined in hex/toBn.ts:35

name: hexToBn

summary: Creates a BN.js bignumber object from a hex string.

description: null inputs returns a BN(0) result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToBn } from '@polkadot/util';
+

Functions

hexToBn

▸ hexToBn(value?: string | number | null, options?: ToBnOptions | boolean): BN

Defined in hex/toBn.ts:35

name: hexToBn

summary: Creates a BN.js bignumber object from a hex string.

description: null inputs returns a BN(0) result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToBn } from '@polkadot/util';
 
 hexToBn('0x123480001f'); // => BN(0x123480001f)
-
1
2
3

Parameters:

Name Type Default value
Optional value string | number | null -
Default value options ToBnOptions | boolean { isLe: false, isNegative: false }

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value string | number | null -
Default value options ToBnOptions | boolean { isLe: false, isNegative: false }

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_tobn_.md b/docs/util/modules/_hex_tobn_.md index eccebe5ff..cc120cb9b 100644 --- a/docs/util/modules/_hex_tobn_.md +++ b/docs/util/modules/_hex_tobn_.md @@ -8,7 +8,7 @@ ▸ **hexToBn**(value?: *`string` \| `number` \| `null`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean`*): `BN` -*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toBn.ts#L35)* +*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toBn.ts#L35)* *__name__*: hexToBn diff --git a/docs/util/modules/_hex_tonumber_.html b/docs/util/modules/_hex_tonumber_.html index 67ca35c83..a20a5f90b 100644 --- a/docs/util/modules/_hex_tonumber_.html +++ b/docs/util/modules/_hex_tonumber_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

hexToNumber

▸ hexToNumber(value?: string | null): number

Defined in hex/toNumber.ts:21

name: hexToNumber

summary: Creates a Number value from a Buffer object.

description: null inputs returns an NaN result, hex values return the actual value as a Number.

example:

import { hexToNumber } from '@polkadot/util';
+

Functions

hexToNumber

▸ hexToNumber(value?: string | null): number

Defined in hex/toNumber.ts:21

name: hexToNumber

summary: Creates a Number value from a Buffer object.

description: null inputs returns an NaN result, hex values return the actual value as a Number.

example:

import { hexToNumber } from '@polkadot/util';
 
 hexToNumber('0x1234'); // => 0x1234
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: number

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: number

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_tonumber_.md b/docs/util/modules/_hex_tonumber_.md index 21c9a12c6..81cf4b49c 100644 --- a/docs/util/modules/_hex_tonumber_.md +++ b/docs/util/modules/_hex_tonumber_.md @@ -8,7 +8,7 @@ ▸ **hexToNumber**(value?: *`string` \| `null`*): `number` -*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toNumber.ts#L21)* +*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toNumber.ts#L21)* *__name__*: hexToNumber diff --git a/docs/util/modules/_hex_tou8a_.html b/docs/util/modules/_hex_tou8a_.html index 38017b40a..9a79d75e9 100644 --- a/docs/util/modules/_hex_tou8a_.html +++ b/docs/util/modules/_hex_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

hexToU8a

▸ hexToU8a(_value?: string | null, bitLength?: number): Uint8Array

Defined in hex/toU8a.ts:24

name: hexToU8a

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Uint8Array result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToU8a } from '@polkadot/util';
+

Functions

hexToU8a

▸ hexToU8a(_value?: string | null, bitLength?: number): Uint8Array

Defined in hex/toU8a.ts:24

name: hexToU8a

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Uint8Array result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToU8a } from '@polkadot/util';
 
 hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
 hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
-
1
2
3
4

Parameters:

Name Type Default value
Optional _value string | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional _value string | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_hex_tou8a_.md b/docs/util/modules/_hex_tou8a_.md index 6a30fddef..84c08a90c 100644 --- a/docs/util/modules/_hex_tou8a_.md +++ b/docs/util/modules/_hex_tou8a_.md @@ -8,7 +8,7 @@ ▸ **hexToU8a**(_value?: *`string` \| `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/hex/toU8a.ts#L24)* +*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/hex/toU8a.ts#L24)* *__name__*: hexToU8a diff --git a/docs/util/modules/_is_bn_.html b/docs/util/modules/_is_bn_.html index 2f03a8bd6..0d3700c5f 100644 --- a/docs/util/modules/_is_bn_.html +++ b/docs/util/modules/_is_bn_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isBn

▸ isBn(value: any): boolean

Defined in is/bn.ts:22

name: isBn

summary: Tests for a BN object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import BN from 'bn.js';
+

Functions

isBn

▸ isBn(value: any): boolean

Defined in is/bn.ts:22

name: isBn

summary: Tests for a BN object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import BN from 'bn.js';
 import { isBn } from '@polkadot/util';
 
 console.log('isBn', isBn(new BN(1))); // => true
-
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_bn_.md b/docs/util/modules/_is_bn_.md index ea9f8ab4d..369102296 100644 --- a/docs/util/modules/_is_bn_.md +++ b/docs/util/modules/_is_bn_.md @@ -8,7 +8,7 @@ ▸ **isBn**(value: *`any`*): `boolean` -*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/bn.ts#L22)* +*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/bn.ts#L22)* *__name__*: isBn diff --git a/docs/util/modules/_is_boolean_.html b/docs/util/modules/_is_boolean_.html index 88a2d02c3..ff8277904 100644 --- a/docs/util/modules/_is_boolean_.html +++ b/docs/util/modules/_is_boolean_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isBoolean

▸ isBoolean(value: any): boolean

Defined in is/boolean.ts:19

name: isBoolean

summary: Tests for a boolean value.

description: Checks to see if the input value is a JavaScript boolean.

example:

import { isBoolean } from '@polkadot/util';
+

Functions

isBoolean

▸ isBoolean(value: any): boolean

Defined in is/boolean.ts:19

name: isBoolean

summary: Tests for a boolean value.

description: Checks to see if the input value is a JavaScript boolean.

example:

import { isBoolean } from '@polkadot/util';
 
 isBoolean(false); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_boolean_.md b/docs/util/modules/_is_boolean_.md index 3f13fbcb4..5e784f588 100644 --- a/docs/util/modules/_is_boolean_.md +++ b/docs/util/modules/_is_boolean_.md @@ -8,7 +8,7 @@ ▸ **isBoolean**(value: *`any`*): `boolean` -*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/boolean.ts#L19)* +*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/boolean.ts#L19)* *__name__*: isBoolean diff --git a/docs/util/modules/_is_buffer_.html b/docs/util/modules/_is_buffer_.html index 54f9a3d04..cd1785588 100644 --- a/docs/util/modules/_is_buffer_.html +++ b/docs/util/modules/_is_buffer_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isBuffer

▸ isBuffer(value: any): boolean

Defined in is/buffer.ts:21

name: isBuffer

summary: Tests for a Buffer object instance.

description: Checks to see if the input object is an instance of Buffer.

example:

import { isBuffer } from '@polkadot/util';
+

Functions

isBuffer

▸ isBuffer(value: any): boolean

Defined in is/buffer.ts:21

name: isBuffer

summary: Tests for a Buffer object instance.

description: Checks to see if the input object is an instance of Buffer.

example:

import { isBuffer } from '@polkadot/util';
 
 console.log('isBuffer', isBuffer(Buffer.from([]))); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_buffer_.md b/docs/util/modules/_is_buffer_.md index 74c02c522..9c6edfe2b 100644 --- a/docs/util/modules/_is_buffer_.md +++ b/docs/util/modules/_is_buffer_.md @@ -8,7 +8,7 @@ ▸ **isBuffer**(value: *`any`*): `boolean` -*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/buffer.ts#L21)* +*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/buffer.ts#L21)* *__name__*: isBuffer diff --git a/docs/util/modules/_is_error_.html b/docs/util/modules/_is_error_.html index 73489e3fa..72f8581db 100644 --- a/docs/util/modules/_is_error_.html +++ b/docs/util/modules/_is_error_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isError

▸ isError(value: any): boolean

Defined in is/error.ts:21

name: isError

summary: Tests for a Error object instance.

description: Checks to see if the input object is an instance of Error.

example:

import { isError } from '@polkadot/util';
+

Functions

isError

▸ isError(value: any): boolean

Defined in is/error.ts:21

name: isError

summary: Tests for a Error object instance.

description: Checks to see if the input object is an instance of Error.

example:

import { isError } from '@polkadot/util';
 
 console.log('isError', isError(new Error('message'))); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_error_.md b/docs/util/modules/_is_error_.md index d4f1e3808..21330e871 100644 --- a/docs/util/modules/_is_error_.md +++ b/docs/util/modules/_is_error_.md @@ -8,7 +8,7 @@ ▸ **isError**(value: *`any`*): `boolean` -*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/error.ts#L21)* +*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/error.ts#L21)* *__name__*: isError diff --git a/docs/util/modules/_is_function_.html b/docs/util/modules/_is_function_.html index c59399bb6..86c58502a 100644 --- a/docs/util/modules/_is_function_.html +++ b/docs/util/modules/_is_function_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isFunction

▸ isFunction(value: any): boolean

Defined in is/function.ts:19

name: isFunction

summary: Tests for a function.

description: Checks to see if the input value is a JavaScript function.

example:

import { isFunction } from '@polkadot/util';
+

Functions

isFunction

▸ isFunction(value: any): boolean

Defined in is/function.ts:19

name: isFunction

summary: Tests for a function.

description: Checks to see if the input value is a JavaScript function.

example:

import { isFunction } from '@polkadot/util';
 
 isFunction(() => false); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_function_.md b/docs/util/modules/_is_function_.md index 2b7aa82c7..0292788e1 100644 --- a/docs/util/modules/_is_function_.md +++ b/docs/util/modules/_is_function_.md @@ -8,7 +8,7 @@ ▸ **isFunction**(value: *`any`*): `boolean` -*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/function.ts#L19)* +*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/function.ts#L19)* *__name__*: isFunction diff --git a/docs/util/modules/_is_hex_.html b/docs/util/modules/_is_hex_.html index d62c6d330..26cc76f89 100644 --- a/docs/util/modules/_is_hex_.html +++ b/docs/util/modules/_is_hex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isHex

▸ isHex(value: any, bitLength?: number, ignoreLength?: boolean): boolean

Defined in is/hex.ts:24

name: isHex

summary: Tests for a hex string.

description: Checks to see if the input value is a 0x prefixed hex string. Optionally (bitLength !== -1) checks to see if the bitLength is correct.

example:

import { isHex } from '@polkadot/util';
+

Functions

isHex

▸ isHex(value: any, bitLength?: number, ignoreLength?: boolean): boolean

Defined in is/hex.ts:24

name: isHex

summary: Tests for a hex string.

description: Checks to see if the input value is a 0x prefixed hex string. Optionally (bitLength !== -1) checks to see if the bitLength is correct.

example:

import { isHex } from '@polkadot/util';
 
 isHex('0x1234'); // => true
 isHex('0x1234', 8); // => false
-
1
2
3
4

Parameters:

Name Type Default value
value any -
Default value bitLength number -1
Default value ignoreLength boolean false

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
value any -
Default value bitLength number -1
Default value ignoreLength boolean false

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_hex_.md b/docs/util/modules/_is_hex_.md index d6ce067ae..2f61dcbfb 100644 --- a/docs/util/modules/_is_hex_.md +++ b/docs/util/modules/_is_hex_.md @@ -8,7 +8,7 @@ ▸ **isHex**(value: *`any`*, bitLength?: *`number`*, ignoreLength?: *`boolean`*): `boolean` -*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/hex.ts#L24)* +*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/hex.ts#L24)* *__name__*: isHex diff --git a/docs/util/modules/_is_instanceof_.html b/docs/util/modules/_is_instanceof_.html index f13031cba..0d997c09d 100644 --- a/docs/util/modules/_is_instanceof_.html +++ b/docs/util/modules/_is_instanceof_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isInstanceOf

▸ isInstanceOf(value: any, clazz: any): boolean

Defined in is/instanceOf.ts:19

name: isInstanceOf

summary: Tests for a instance of a class.

description: Checks to see if the input value is an instance of the test class.

example:

import { isInstanceOf } from '@polkadot/util';
+

Functions

isInstanceOf

▸ isInstanceOf(value: any, clazz: any): boolean

Defined in is/instanceOf.ts:19

name: isInstanceOf

summary: Tests for a instance of a class.

description: Checks to see if the input value is an instance of the test class.

example:

import { isInstanceOf } from '@polkadot/util';
 
 console.log('isInstanceOf', isInstanceOf(new Array(0), Array)); // => true
-
1
2
3

Parameters:

Name Type
value any
clazz any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any
clazz any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_instanceof_.md b/docs/util/modules/_is_instanceof_.md index 37955156f..3f50c5da8 100644 --- a/docs/util/modules/_is_instanceof_.md +++ b/docs/util/modules/_is_instanceof_.md @@ -8,7 +8,7 @@ ▸ **isInstanceOf**(value: *`any`*, clazz: *`any`*): `boolean` -*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/instanceOf.ts#L19)* +*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/instanceOf.ts#L19)* *__name__*: isInstanceOf diff --git a/docs/util/modules/_is_ip_.html b/docs/util/modules/_is_ip_.html index 8ef6342e6..4116bf7af 100644 --- a/docs/util/modules/_is_ip_.html +++ b/docs/util/modules/_is_ip_.html @@ -7,7 +7,7 @@ - + @@ -15,13 +15,13 @@ GitHub

Functions

isIp

▸ isIp(value: string, type?: IpTypes): boolean

Defined in is/ip.ts:26

name: isIp

summary: Tests if the value is a valid IP address

description: Checks to see if the value is a valid IP address. Optionally check for either v4/v6

example:

import { isIp } from '@polkadot/util';
+

Functions

isIp

▸ isIp(value: string, type?: IpTypes): boolean

Defined in is/ip.ts:26

name: isIp

summary: Tests if the value is a valid IP address

description: Checks to see if the value is a valid IP address. Optionally check for either v4/v6

example:

import { isIp } from '@polkadot/util';
 
 isIp('192.168.0.1')); // => true
 isIp('1:2:3:4:5:6:7:8'); // => true
 isIp('192.168.0.1', 'v6')); // => false
 isIp('1:2:3:4:5:6:7:8', 'v4'); // => false
-
1
2
3
4
5
6

Parameters:

Name Type
value string
Optional type IpTypes

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
value string
Optional type IpTypes

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_ip_.md b/docs/util/modules/_is_ip_.md index 863f11cc8..36cb6a758 100644 --- a/docs/util/modules/_is_ip_.md +++ b/docs/util/modules/_is_ip_.md @@ -8,7 +8,7 @@ ▸ **isIp**(value: *`string`*, type?: *`IpTypes`*): `boolean` -*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/ip.ts#L26)* +*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/ip.ts#L26)* *__name__*: isIp diff --git a/docs/util/modules/_is_null_.html b/docs/util/modules/_is_null_.html index 579dd5fa6..dc658f22d 100644 --- a/docs/util/modules/_is_null_.html +++ b/docs/util/modules/_is_null_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isNull

▸ isNull(value?: any): boolean

Defined in is/null.ts:19

name: isNull

summary: Tests for a null values.

description: Checks to see if the input value is null.

example:

import { isNull } from '@polkadot/util';
+

Functions

isNull

▸ isNull(value?: any): boolean

Defined in is/null.ts:19

name: isNull

summary: Tests for a null values.

description: Checks to see if the input value is null.

example:

import { isNull } from '@polkadot/util';
 
 console.log('isNull', isNull(null)); // => true
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_null_.md b/docs/util/modules/_is_null_.md index ef026bf40..5236fcd00 100644 --- a/docs/util/modules/_is_null_.md +++ b/docs/util/modules/_is_null_.md @@ -8,7 +8,7 @@ ▸ **isNull**(value?: *`any`*): `boolean` -*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/null.ts#L19)* +*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/null.ts#L19)* *__name__*: isNull diff --git a/docs/util/modules/_is_number_.html b/docs/util/modules/_is_number_.html index d416b621c..086f7e11f 100644 --- a/docs/util/modules/_is_number_.html +++ b/docs/util/modules/_is_number_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isNumber

▸ isNumber(value: any): boolean

Defined in is/number.ts:19

name: isNumber

summary: Tests for a JavaScript number.

description: Checks to see if the input value is a valid number.

example:

import { isNumber } from '@polkadot/util';
+

Functions

isNumber

▸ isNumber(value: any): boolean

Defined in is/number.ts:19

name: isNumber

summary: Tests for a JavaScript number.

description: Checks to see if the input value is a valid number.

example:

import { isNumber } from '@polkadot/util';
 
 console.log('isNumber', isNumber(1234)); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_number_.md b/docs/util/modules/_is_number_.md index d24690dd0..8ddb5ed86 100644 --- a/docs/util/modules/_is_number_.md +++ b/docs/util/modules/_is_number_.md @@ -8,7 +8,7 @@ ▸ **isNumber**(value: *`any`*): `boolean` -*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/number.ts#L19)* +*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/number.ts#L19)* *__name__*: isNumber diff --git a/docs/util/modules/_is_object_.html b/docs/util/modules/_is_object_.html index a525f8123..22292b6d6 100644 --- a/docs/util/modules/_is_object_.html +++ b/docs/util/modules/_is_object_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

isObject

▸ isObject(value: any): boolean

Defined in is/object.ts:24

name: isObject

summary: Tests for an object.

description: Checks to see if the input value is a JavaScript object.

example:

import { isObject } from '@polkadot/util';
+

Functions

isObject

▸ isObject(value: any): boolean

Defined in is/object.ts:24

name: isObject

summary: Tests for an object.

description: Checks to see if the input value is a JavaScript object.

example:

import { isObject } from '@polkadot/util';
 
 isObject({}); // => true
 isObject('something'); // => false
-
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_object_.md b/docs/util/modules/_is_object_.md index 07f7f5c81..7bdb10927 100644 --- a/docs/util/modules/_is_object_.md +++ b/docs/util/modules/_is_object_.md @@ -8,7 +8,7 @@ ▸ **isObject**(value: *`any`*): `boolean` -*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/object.ts#L24)* +*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/object.ts#L24)* *__name__*: isObject diff --git a/docs/util/modules/_is_observable_.html b/docs/util/modules/_is_observable_.html index 2a09e1ebc..17dfc756e 100644 --- a/docs/util/modules/_is_observable_.html +++ b/docs/util/modules/_is_observable_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isObservable

▸ isObservable(value: any): boolean

Defined in is/observable.ts:26

name: isBObservable

summary: Tests for a Observable object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import { isObservable } from '@polkadot/util';
+

Functions

isObservable

▸ isObservable(value: any): boolean

Defined in is/observable.ts:26

name: isBObservable

summary: Tests for a Observable object instance.

description: Checks to see if the input object is an instance of BN (bn.js).

example:

import { isObservable } from '@polkadot/util';
 
 console.log('isObservable', isObservable(...));
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_observable_.md b/docs/util/modules/_is_observable_.md index 578b0aab7..89f8c54c1 100644 --- a/docs/util/modules/_is_observable_.md +++ b/docs/util/modules/_is_observable_.md @@ -8,7 +8,7 @@ ▸ **isObservable**(value: *`any`*): `boolean` -*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/observable.ts#L26)* +*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/observable.ts#L26)* *__name__*: isBObservable diff --git a/docs/util/modules/_is_string_.html b/docs/util/modules/_is_string_.html index 8cb4e1799..8a90cf17d 100644 --- a/docs/util/modules/_is_string_.html +++ b/docs/util/modules/_is_string_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isString

▸ isString(value: any): boolean

Defined in is/string.ts:19

name: isString

summary: Tests for a string.

description: Checks to see if the input value is a JavaScript string.

example:

import { isString } from '@polkadot/util';
+

Functions

isString

▸ isString(value: any): boolean

Defined in is/string.ts:19

name: isString

summary: Tests for a string.

description: Checks to see if the input value is a JavaScript string.

example:

import { isString } from '@polkadot/util';
 
 console.log('isString', isString('test')); // => true
-
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_string_.md b/docs/util/modules/_is_string_.md index 4db2aea4f..0d07fd467 100644 --- a/docs/util/modules/_is_string_.md +++ b/docs/util/modules/_is_string_.md @@ -8,7 +8,7 @@ ▸ **isString**(value: *`any`*): `boolean` -*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/string.ts#L19)* +*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/string.ts#L19)* *__name__*: isString diff --git a/docs/util/modules/_is_u8a_.html b/docs/util/modules/_is_u8a_.html index 8c513afdd..141d7de16 100644 --- a/docs/util/modules/_is_u8a_.html +++ b/docs/util/modules/_is_u8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isU8a

▸ isU8a(value?: any): boolean

Defined in is/u8a.ts:21

name: isU8a

summary: Tests for a Uint8Array object instance.

description: Checks to see if the input object is an instance of Uint8Array.

example:

import { isUint8Array } from '@polkadot/util';
+

Functions

isU8a

▸ isU8a(value?: any): boolean

Defined in is/u8a.ts:21

name: isU8a

summary: Tests for a Uint8Array object instance.

description: Checks to see if the input object is an instance of Uint8Array.

example:

import { isUint8Array } from '@polkadot/util';
 
 console.log('isU8a', isU8a([])); // => false
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_u8a_.md b/docs/util/modules/_is_u8a_.md index aeb0f49bc..88b04c9fa 100644 --- a/docs/util/modules/_is_u8a_.md +++ b/docs/util/modules/_is_u8a_.md @@ -8,7 +8,7 @@ ▸ **isU8a**(value?: *`any`*): `boolean` -*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/u8a.ts#L21)* +*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/u8a.ts#L21)* *__name__*: isU8a diff --git a/docs/util/modules/_is_undefined_.html b/docs/util/modules/_is_undefined_.html index 1555393a5..7358fd508 100644 --- a/docs/util/modules/_is_undefined_.html +++ b/docs/util/modules/_is_undefined_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

isUndefined

▸ isUndefined(value?: any): boolean

Defined in is/undefined.ts:19

name: isUndefined

summary: Tests for a undefined values.

description: Checks to see if the input value is undefined.

example:

import { isUndefined } from '@polkadot/util';
+

Functions

isUndefined

▸ isUndefined(value?: any): boolean

Defined in is/undefined.ts:19

name: isUndefined

summary: Tests for a undefined values.

description: Checks to see if the input value is undefined.

example:

import { isUndefined } from '@polkadot/util';
 
 console.log('isUndefined', isUndefined(void(0))); // => true
-
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_is_undefined_.md b/docs/util/modules/_is_undefined_.md index 630058fd3..f4d23af03 100644 --- a/docs/util/modules/_is_undefined_.md +++ b/docs/util/modules/_is_undefined_.md @@ -8,7 +8,7 @@ ▸ **isUndefined**(value?: *`any`*): `boolean` -*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/is/undefined.ts#L19)* +*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/is/undefined.ts#L19)* *__name__*: isUndefined diff --git a/docs/util/modules/_logger_.html b/docs/util/modules/_logger_.html index ead98e7b4..496140c1f 100644 --- a/docs/util/modules/_logger_.html +++ b/docs/util/modules/_logger_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

format

▸ format(value: any): any

Defined in logger.ts:42

Parameters:

Name Type
value any

Returns: any

logger

▸ logger(_type: string): Logger

Defined in logger.ts:104

name: Logger

summary: Creates a consistent log interface for messages

description: Returns a Logger that has .log, .error, .warn and .debug (controlled with environment DEBUG=typeA,typeB) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.

example:

const l from '@polkadot/util/logger')('test');
+

Functions

format

▸ format(value: any): any

Defined in logger.ts:42

Parameters:

Name Type
value any

Returns: any

logger

▸ logger(_type: string): Logger

Defined in logger.ts:104

name: Logger

summary: Creates a consistent log interface for messages

description: Returns a Logger that has .log, .error, .warn and .debug (controlled with environment DEBUG=typeA,typeB) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.

example:

const l from '@polkadot/util/logger')('test');
 
 l.log('blah'); // <date>     TEST: blah
-
1
2
3

Parameters:

Name Type
_type string

Returns: Logger

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
_type string

Returns: Logger

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_logger_.md b/docs/util/modules/_logger_.md index 8ba19b42e..a6e07d64b 100644 --- a/docs/util/modules/_logger_.md +++ b/docs/util/modules/_logger_.md @@ -8,7 +8,7 @@ ▸ **format**(value: *`any`*): `any` -*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/logger.ts#L42)* +*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L42)* **Parameters:** @@ -25,7 +25,7 @@ ___ ▸ **logger**(_type: *`string`*): [Logger](_types_.md#logger) -*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/logger.ts#L104)* +*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/logger.ts#L104)* *__name__*: Logger diff --git a/docs/util/modules/_number_tohex_.html b/docs/util/modules/_number_tohex_.html index 05d3c31f3..6e29b0a68 100644 --- a/docs/util/modules/_number_tohex_.html +++ b/docs/util/modules/_number_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

numberToHex

▸ numberToHex(value?: number | null, bitLength?: number): string

Defined in number/toHex.ts:24

name: numberToHex

summary: Creates a hex value from a number.

description: null/undefined/NaN inputs returns an empty 0x result. number input values return the actual bytes value converted to a hex. With bitLength set, it converts the number to the equivalent size.

example:

import { numberToHex } from '@polkadot/util';
+

Functions

numberToHex

▸ numberToHex(value?: number | null, bitLength?: number): string

Defined in number/toHex.ts:24

name: numberToHex

summary: Creates a hex value from a number.

description: null/undefined/NaN inputs returns an empty 0x result. number input values return the actual bytes value converted to a hex. With bitLength set, it converts the number to the equivalent size.

example:

import { numberToHex } from '@polkadot/util';
 
 numberToHex(0x1234); // => '0x1234'
 numberToHex(0x1234, 32); // => 0x00001234
-
1
2
3
4

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_number_tohex_.md b/docs/util/modules/_number_tohex_.md index 9abd047c1..a91d2ef31 100644 --- a/docs/util/modules/_number_tohex_.md +++ b/docs/util/modules/_number_tohex_.md @@ -8,7 +8,7 @@ ▸ **numberToHex**(value?: *`number` \| `null`*, bitLength?: *`number`*): `string` -*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/number/toHex.ts#L24)* +*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toHex.ts#L24)* *__name__*: numberToHex diff --git a/docs/util/modules/_number_tou8a_.html b/docs/util/modules/_number_tou8a_.html index c2319b3d9..3039a8774 100644 --- a/docs/util/modules/_number_tou8a_.html +++ b/docs/util/modules/_number_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

numberToU8a

▸ numberToU8a(value?: number | null, bitLength?: number): Uint8Array

Defined in number/toU8a.ts:22

name: numberToU8a

summary: Creates a Uint8Array object from a number.

description: null/undefined/NaN inputs returns an empty Uint8Array result. number input values return the actual bytes value converted to a Uint8Array. With bitLength, it converts the value to the equivalent size.

example:

import { numberToU8a } from '@polkadot/util';
+

Functions

numberToU8a

▸ numberToU8a(value?: number | null, bitLength?: number): Uint8Array

Defined in number/toU8a.ts:22

name: numberToU8a

summary: Creates a Uint8Array object from a number.

description: null/undefined/NaN inputs returns an empty Uint8Array result. number input values return the actual bytes value converted to a Uint8Array. With bitLength, it converts the value to the equivalent size.

example:

import { numberToU8a } from '@polkadot/util';
 
 numberToU8a(0x1234); // => [0x12, 0x34]
-
1
2
3

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value number | null -
Default value bitLength number -1

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_number_tou8a_.md b/docs/util/modules/_number_tou8a_.md index 5341d5529..71d9c3fd5 100644 --- a/docs/util/modules/_number_tou8a_.md +++ b/docs/util/modules/_number_tou8a_.md @@ -8,7 +8,7 @@ ▸ **numberToU8a**(value?: *`number` \| `null`*, bitLength?: *`number`*): `Uint8Array` -*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/number/toU8a.ts#L22)* +*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/number/toU8a.ts#L22)* *__name__*: numberToU8a diff --git a/docs/util/modules/_polyfill_fill_.html b/docs/util/modules/_polyfill_fill_.html index 15c048c7c..de9e21e5d 100644 --- a/docs/util/modules/_polyfill_fill_.html +++ b/docs/util/modules/_polyfill_fill_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_polyfill_padend_.html b/docs/util/modules/_polyfill_padend_.html index 830e81c69..f539854e6 100644 --- a/docs/util/modules/_polyfill_padend_.html +++ b/docs/util/modules/_polyfill_padend_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_polyfill_padstart_.html b/docs/util/modules/_polyfill_padstart_.html index 755189813..2e5bd2f1f 100644 --- a/docs/util/modules/_polyfill_padstart_.html +++ b/docs/util/modules/_polyfill_padstart_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_polyfill_setprototypeof_.html b/docs/util/modules/_polyfill_setprototypeof_.html index f054beb49..077b40553 100644 --- a/docs/util/modules/_polyfill_setprototypeof_.html +++ b/docs/util/modules/_polyfill_setprototypeof_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_polyfill_textdecoder_.html b/docs/util/modules/_polyfill_textdecoder_.html index aff8e9dc1..f6bc5b1a6 100644 --- a/docs/util/modules/_polyfill_textdecoder_.html +++ b/docs/util/modules/_polyfill_textdecoder_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_polyfill_textencoder_.html b/docs/util/modules/_polyfill_textencoder_.html index a71c09cf0..59beaa7b4 100644 --- a/docs/util/modules/_polyfill_textencoder_.html +++ b/docs/util/modules/_polyfill_textencoder_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_promisify_.html b/docs/util/modules/_promisify_.html index 536f78dcc..a2ff90291 100644 --- a/docs/util/modules/_promisify_.html +++ b/docs/util/modules/_promisify_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

promisify

▸ promisify(self: any, fn: Function, ...params: Array<any>): Promise<any>

Defined in promisify.ts:20

name: promisify

summary: Wraps an async callback into a Promise

description: Wraps the supplied async function fn that has a standard JS callback (error: Error, result: any) into a Promise, passing the supplied parameters. When error is set, the Promise is rejected, else the Promise resolves with the result value.

example:

const { promisify } from '@polkadot/util';
+

Functions

promisify

▸ promisify(self: any, fn: Function, ...params: Array<any>): Promise<any>

Defined in promisify.ts:20

name: promisify

summary: Wraps an async callback into a Promise

description: Wraps the supplied async function fn that has a standard JS callback (error: Error, result: any) into a Promise, passing the supplied parameters. When error is set, the Promise is rejected, else the Promise resolves with the result value.

example:

const { promisify } from '@polkadot/util';
 
 await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
 await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
-
1
2
3
4

Parameters:

Name Type
self any
fn Function
Rest params Array<any>

Returns: Promise<any>

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
self any
fn Function
Rest params Array<any>

Returns: Promise<any>

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_promisify_.md b/docs/util/modules/_promisify_.md index c8e8ec37d..7eabf48e9 100644 --- a/docs/util/modules/_promisify_.md +++ b/docs/util/modules/_promisify_.md @@ -8,7 +8,7 @@ ▸ **promisify**(self: *`any`*, fn: *`Function`*, ...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/promisify.ts#L20)* +*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/promisify.ts#L20)* *__name__*: promisify diff --git a/docs/util/modules/_string_camelcase_.html b/docs/util/modules/_string_camelcase_.html index 689b02b32..1cd1bf99a 100644 --- a/docs/util/modules/_string_camelcase_.html +++ b/docs/util/modules/_string_camelcase_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub
Last Updated: 2/13/2019, 4:33:49 PM
- +
Last Updated: 2/13/2019, 4:38:56 PM
+ diff --git a/docs/util/modules/_string_lowerfirst_.html b/docs/util/modules/_string_lowerfirst_.html index 6a3021441..3703daca2 100644 --- a/docs/util/modules/_string_lowerfirst_.html +++ b/docs/util/modules/_string_lowerfirst_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringLowerFirst

▸ stringLowerFirst(value?: string | null): string

Defined in string/lowerFirst.ts:19

name: stringLowerFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringLowerFirst } from '@polkadot/util';
+

Functions

stringLowerFirst

▸ stringLowerFirst(value?: string | null): string

Defined in string/lowerFirst.ts:19

name: stringLowerFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringLowerFirst } from '@polkadot/util';
 
 stringLowerFirst('ABC'); // => 'aBC'
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_string_lowerfirst_.md b/docs/util/modules/_string_lowerfirst_.md index f51186f5d..dc1698a73 100644 --- a/docs/util/modules/_string_lowerfirst_.md +++ b/docs/util/modules/_string_lowerfirst_.md @@ -8,7 +8,7 @@ ▸ **stringLowerFirst**(value?: *`string` \| `null`*): `string` -*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/lowerFirst.ts#L19)* +*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/lowerFirst.ts#L19)* *__name__*: stringLowerFirst diff --git a/docs/util/modules/_string_shorten_.html b/docs/util/modules/_string_shorten_.html index 7edf7b303..48152d317 100644 --- a/docs/util/modules/_string_shorten_.html +++ b/docs/util/modules/_string_shorten_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringShorten

▸ stringShorten(_value?: any, prefixLength?: number): string

Defined in string/shorten.ts:19

name: stringShorten

summary: Returns a string with maximum length

description: Checks the string against the prefixLength, if longer than dopuble this, shortens it by placing .. in the middle of it

example:

import { stringShorten } from '@polkadot/util';
+

Functions

stringShorten

▸ stringShorten(_value?: any, prefixLength?: number): string

Defined in string/shorten.ts:19

name: stringShorten

summary: Returns a string with maximum length

description: Checks the string against the prefixLength, if longer than dopuble this, shortens it by placing .. in the middle of it

example:

import { stringShorten } from '@polkadot/util';
 
 stringShorten('1234567890', 2); // => 12..90
-
1
2
3

Parameters:

Name Type Default value
Optional _value any -
Default value prefixLength number 6

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional _value any -
Default value prefixLength number 6

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_string_shorten_.md b/docs/util/modules/_string_shorten_.md index f0e67b725..e7f7dd7de 100644 --- a/docs/util/modules/_string_shorten_.md +++ b/docs/util/modules/_string_shorten_.md @@ -8,7 +8,7 @@ ▸ **stringShorten**(_value?: *`any`*, prefixLength?: *`number`*): `string` -*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/shorten.ts#L19)* +*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/shorten.ts#L19)* *__name__*: stringShorten diff --git a/docs/util/modules/_string_tou8a_.html b/docs/util/modules/_string_tou8a_.html index ceb3867b6..5232134f0 100644 --- a/docs/util/modules/_string_tou8a_.html +++ b/docs/util/modules/_string_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringToU8a

▸ stringToU8a(value?: undefined | string): Uint8Array

Defined in string/toU8a.ts:39

name: stringToU8a

summary: Creates a Uint8Array object from a utf-8 string.

description: String input values return the actual encoded UInt8Array. null or undefined values returns an empty encoded array.

example:

import { stringToU8a } from '@polkadot/util';
+

Functions

stringToU8a

▸ stringToU8a(value?: undefined | string): Uint8Array

Defined in string/toU8a.ts:39

name: stringToU8a

summary: Creates a Uint8Array object from a utf-8 string.

description: String input values return the actual encoded UInt8Array. null or undefined values returns an empty encoded array.

example:

import { stringToU8a } from '@polkadot/util';
 
 stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
-
1
2
3

Parameters:

Name Type
Optional value undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_string_tou8a_.md b/docs/util/modules/_string_tou8a_.md index 22fc7744c..5dc183200 100644 --- a/docs/util/modules/_string_tou8a_.md +++ b/docs/util/modules/_string_tou8a_.md @@ -8,7 +8,7 @@ ▸ **stringToU8a**(value?: *`undefined` \| `string`*): `Uint8Array` -*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/toU8a.ts#L39)* +*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/toU8a.ts#L39)* *__name__*: stringToU8a diff --git a/docs/util/modules/_string_upperfirst_.html b/docs/util/modules/_string_upperfirst_.html index 2b2f0edd6..19e7d69aa 100644 --- a/docs/util/modules/_string_upperfirst_.html +++ b/docs/util/modules/_string_upperfirst_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

stringUpperFirst

▸ stringUpperFirst(value?: string | null): string

Defined in string/upperFirst.ts:19

name: stringUpperFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringUpperFirst } from '@polkadot/util';
+

Functions

stringUpperFirst

▸ stringUpperFirst(value?: string | null): string

Defined in string/upperFirst.ts:19

name: stringUpperFirst

summary: Lowercase the first letter of a string

description: Lowercase the first letter of a string

example:

import { stringUpperFirst } from '@polkadot/util';
 
 stringUpperFirst('abc'); // => 'Abc'
-
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_string_upperfirst_.md b/docs/util/modules/_string_upperfirst_.md index 9edc91196..6fa36ca8d 100644 --- a/docs/util/modules/_string_upperfirst_.md +++ b/docs/util/modules/_string_upperfirst_.md @@ -8,7 +8,7 @@ ▸ **stringUpperFirst**(value?: *`string` \| `null`*): `string` -*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/string/upperFirst.ts#L19)* +*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/string/upperFirst.ts#L19)* *__name__*: stringUpperFirst diff --git a/docs/util/modules/_syncify_.html b/docs/util/modules/_syncify_.html index f600381d2..f9f52bca9 100644 --- a/docs/util/modules/_syncify_.html +++ b/docs/util/modules/_syncify_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Functions

syncify

▸ syncify(promise: Promise<any>): any

Defined in syncify.ts:11

Parameters:

Name Type
promise Promise<any>

Returns: any

Last Updated: 2/26/2019, 11:08:42 AM
- +

Functions

syncify

▸ syncify(promise: Promise<any>): any

Defined in syncify.ts:11

Parameters:

Name Type
promise Promise<any>

Returns: any

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_syncify_.md b/docs/util/modules/_syncify_.md index 96824432b..f0e740b1c 100644 --- a/docs/util/modules/_syncify_.md +++ b/docs/util/modules/_syncify_.md @@ -8,7 +8,7 @@ ▸ **syncify**(promise: *`Promise`<`any`>*): `any` -*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/syncify.ts#L11)* +*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/syncify.ts#L11)* **Parameters:** diff --git a/docs/util/modules/_types_.html b/docs/util/modules/_types_.html index 3c5ca7a2d..b252d2da4 100644 --- a/docs/util/modules/_types_.html +++ b/docs/util/modules/_types_.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@ GitHub

Index

Interfaces

Type aliases

Type aliases

Logger

Ƭ Logger: object

Defined in types.ts:15

Type declaration

Logger$Data

Ƭ Logger$Data: Array<any | Logger$Data$Fn>

Defined in types.ts:13

Last Updated: 2/26/2019, 11:08:42 AM
- +

Index

Interfaces

Type aliases

Type aliases

Logger

Ƭ Logger: object

Defined in types.ts:15

Type declaration

Logger$Data

Ƭ Logger$Data: Array<any | Logger$Data$Fn>

Defined in types.ts:13

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_types_.md b/docs/util/modules/_types_.md index 0014fd4fa..e44c95f4b 100644 --- a/docs/util/modules/_types_.md +++ b/docs/util/modules/_types_.md @@ -22,7 +22,7 @@ **Ƭ Logger**: *`object`* -*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L15)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ Logger$Data**: *`Array`<`any` \| `Logger$Data$Fn`>* -*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L13)* ___ diff --git a/docs/util/modules/_u8a_concat_.html b/docs/util/modules/_u8a_concat_.html index b6e29015b..402e0a961 100644 --- a/docs/util/modules/_u8a_concat_.html +++ b/docs/util/modules/_u8a_concat_.html @@ -7,7 +7,7 @@ - + @@ -15,13 +15,13 @@ GitHub

Functions

u8aConcat

▸ u8aConcat(..._list: Array<Uint8Array | string>): Uint8Array

Defined in u8a/concat.ts:24

name: u8aConcat

summary: Creates a concatenated Uint8Array from the inputs.

description: Concatenates the input arrays into a single UInt8Array.

example:

import { u8aConcat } from '@polkadot/util';
+

Functions

u8aConcat

▸ u8aConcat(..._list: Array<Uint8Array | string>): Uint8Array

Defined in u8a/concat.ts:24

name: u8aConcat

summary: Creates a concatenated Uint8Array from the inputs.

description: Concatenates the input arrays into a single UInt8Array.

example:

import { u8aConcat } from '@polkadot/util';
 
 u8aConcat(
   new Uint8Array([1, 2, 3]),
   new Uint8Array([4, 5, 6])
 ); // [1, 2, 3, 4, 5, 6]
-
1
2
3
4
5
6

Parameters:

Name Type
Rest _list Array<Uint8Array | string>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
Rest _list Array<Uint8Array | string>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_concat_.md b/docs/util/modules/_u8a_concat_.md index 8a3c29d12..c64a844f8 100644 --- a/docs/util/modules/_u8a_concat_.md +++ b/docs/util/modules/_u8a_concat_.md @@ -8,7 +8,7 @@ ▸ **u8aConcat**(..._list: *`Array`<`Uint8Array` \| `string`>*): `Uint8Array` -*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/concat.ts#L24)* +*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/concat.ts#L24)* *__name__*: u8aConcat diff --git a/docs/util/modules/_u8a_fixlength_.html b/docs/util/modules/_u8a_fixlength_.html index 43631e37b..e509030b1 100644 --- a/docs/util/modules/_u8a_fixlength_.html +++ b/docs/util/modules/_u8a_fixlength_.html @@ -7,7 +7,7 @@ - + @@ -15,12 +15,12 @@ GitHub

Functions

u8aFixLength

▸ u8aFixLength(value: Uint8Array, bitLength?: number, atStart?: boolean): Uint8Array

Defined in u8a/fixLength.ts:21

name: u8aFixLength

summary: Shifts a Uint8Array to a specific bitLength

description: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.

example:

import { u8aFixLength } from '@polkadot/util';
+

Functions

u8aFixLength

▸ u8aFixLength(value: Uint8Array, bitLength?: number, atStart?: boolean): Uint8Array

Defined in u8a/fixLength.ts:21

name: u8aFixLength

summary: Shifts a Uint8Array to a specific bitLength

description: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.

example:

import { u8aFixLength } from '@polkadot/util';
 
 u8aFixLength('0x12') // => 0x12
 u8aFixLength('0x12', 16) // => 0x0012
 u8aFixLength('0x1234', 8) // => 0x12
-
1
2
3
4
5

Parameters:

Name Type Default value
value Uint8Array -
Default value bitLength number -1
Default value atStart boolean false

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4
5

Parameters:

Name Type Default value
value Uint8Array -
Default value bitLength number -1
Default value atStart boolean false

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_fixlength_.md b/docs/util/modules/_u8a_fixlength_.md index 3b426216e..292b18885 100644 --- a/docs/util/modules/_u8a_fixlength_.md +++ b/docs/util/modules/_u8a_fixlength_.md @@ -8,7 +8,7 @@ ▸ **u8aFixLength**(value: *`Uint8Array`*, bitLength?: *`number`*, atStart?: *`boolean`*): `Uint8Array` -*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/fixLength.ts#L21)* +*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/fixLength.ts#L21)* *__name__*: u8aFixLength diff --git a/docs/util/modules/_u8a_tobn_.html b/docs/util/modules/_u8a_tobn_.html index c1363b674..2ee815f8b 100644 --- a/docs/util/modules/_u8a_tobn_.html +++ b/docs/util/modules/_u8a_tobn_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToBn

▸ u8aToBn(value: Uint8Array, options?: ToBnOptions | boolean): BN

Defined in u8a/toBn.ts:29

name: u8aToBn

summary: Creates a BN from a Uint8Array object.

description: UInt8Array input values return the actual BN. null or undefined values returns an 0x0 value.

example:

import { u8aToBn } from '@polkadot/util';
+

Functions

u8aToBn

▸ u8aToBn(value: Uint8Array, options?: ToBnOptions | boolean): BN

Defined in u8a/toBn.ts:29

name: u8aToBn

summary: Creates a BN from a Uint8Array object.

description: UInt8Array input values return the actual BN. null or undefined values returns an 0x0 value.

example:

import { u8aToBn } from '@polkadot/util';
 
 u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
-
1
2
3

Parameters:

Name Type Default value Description
value Uint8Array - The value to convert
Default value options ToBnOptions | boolean { isLe: true, isNegative: false } Options to pass while converting

Returns: BN

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value Description
value Uint8Array - The value to convert
Default value options ToBnOptions | boolean { isLe: true, isNegative: false } Options to pass while converting

Returns: BN

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_tobn_.md b/docs/util/modules/_u8a_tobn_.md index 0315de5c2..15360d2f4 100644 --- a/docs/util/modules/_u8a_tobn_.md +++ b/docs/util/modules/_u8a_tobn_.md @@ -8,7 +8,7 @@ ▸ **u8aToBn**(value: *`Uint8Array`*, options?: *[ToBnOptions](../interfaces/_types_.tobnoptions.md) \| `boolean`*): `BN` -*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toBn.ts#L29)* +*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBn.ts#L29)* *__name__*: u8aToBn diff --git a/docs/util/modules/_u8a_tobuffer_.html b/docs/util/modules/_u8a_tobuffer_.html index f5c611760..e7289b76b 100644 --- a/docs/util/modules/_u8a_tobuffer_.html +++ b/docs/util/modules/_u8a_tobuffer_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToBuffer

▸ u8aToBuffer(value?: Uint8Array | null): Buffer

Defined in u8a/toBuffer.ts:19

name: u8aToBuffer

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Buffer result. UInt8Array input values return the actual bytes value converted to a Buffer. Anything that is not a UInt8Array throws an error.

example:

import { u8aToBuffer } from '@polkadot/util';
+

Functions

u8aToBuffer

▸ u8aToBuffer(value?: Uint8Array | null): Buffer

Defined in u8a/toBuffer.ts:19

name: u8aToBuffer

summary: Creates a Buffer object from a hex string.

description: null inputs returns an empty Buffer result. UInt8Array input values return the actual bytes value converted to a Buffer. Anything that is not a UInt8Array throws an error.

example:

import { u8aToBuffer } from '@polkadot/util';
 
 console.log('Buffer', u8aToBuffer('0x123480001f'));
-
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: Buffer

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: Buffer

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_tobuffer_.md b/docs/util/modules/_u8a_tobuffer_.md index 898fe2ee3..4338a27f6 100644 --- a/docs/util/modules/_u8a_tobuffer_.md +++ b/docs/util/modules/_u8a_tobuffer_.md @@ -8,7 +8,7 @@ ▸ **u8aToBuffer**(value?: *`Uint8Array` \| `null`*): `Buffer` -*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toBuffer.ts#L19)* +*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toBuffer.ts#L19)* *__name__*: u8aToBuffer diff --git a/docs/util/modules/_u8a_tohex_.html b/docs/util/modules/_u8a_tohex_.html index e3ba63efc..a93890bb1 100644 --- a/docs/util/modules/_u8a_tohex_.html +++ b/docs/util/modules/_u8a_tohex_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToHex

▸ u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): string

Defined in u8a/toHex.ts:21

name: u8aToHex

summary: Creates a hex string from a Uint8Array object.

description: UInt8Array input values return the actual hex string. null or undefined values returns an 0x string.

example:

import { u8aToHex } from '@polkadot/util';
+

Functions

u8aToHex

▸ u8aToHex(value?: Uint8Array | null, bitLength?: number, isPrefixed?: boolean): string

Defined in u8a/toHex.ts:21

name: u8aToHex

summary: Creates a hex string from a Uint8Array object.

description: UInt8Array input values return the actual hex string. null or undefined values returns an 0x string.

example:

import { u8aToHex } from '@polkadot/util';
 
 u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f
-
1
2
3

Parameters:

Name Type Default value
Optional value Uint8Array | null -
Default value bitLength number -1
Default value isPrefixed boolean true

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type Default value
Optional value Uint8Array | null -
Default value bitLength number -1
Default value isPrefixed boolean true

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_tohex_.md b/docs/util/modules/_u8a_tohex_.md index f0d27190b..03c9fff68 100644 --- a/docs/util/modules/_u8a_tohex_.md +++ b/docs/util/modules/_u8a_tohex_.md @@ -8,7 +8,7 @@ ▸ **u8aToHex**(value?: *`Uint8Array` \| `null`*, bitLength?: *`number`*, isPrefixed?: *`boolean`*): `string` -*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toHex.ts#L21)* +*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toHex.ts#L21)* *__name__*: u8aToHex diff --git a/docs/util/modules/_u8a_tostring_.html b/docs/util/modules/_u8a_tostring_.html index 8fdb9b8c5..b9a0b382a 100644 --- a/docs/util/modules/_u8a_tostring_.html +++ b/docs/util/modules/_u8a_tostring_.html @@ -7,7 +7,7 @@ - + @@ -15,10 +15,10 @@ GitHub

Functions

u8aToString

▸ u8aToString(value?: Uint8Array | null): string

Defined in u8a/toString.ts:35

name: u8aToString

summary: Creates a utf-8 string from a Uint8Array object.

description: UInt8Array input values return the actual decoded utf-8 string. null or undefined values returns an empty string.

example:

import { u8aToString } from '@polkadot/util';
+

Functions

u8aToString

▸ u8aToString(value?: Uint8Array | null): string

Defined in u8a/toString.ts:35

name: u8aToString

summary: Creates a utf-8 string from a Uint8Array object.

description: UInt8Array input values return the actual decoded utf-8 string. null or undefined values returns an empty string.

example:

import { u8aToString } from '@polkadot/util';
 
 u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello
-
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: string

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: string

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_tostring_.md b/docs/util/modules/_u8a_tostring_.md index cffca657c..a7d3899cf 100644 --- a/docs/util/modules/_u8a_tostring_.md +++ b/docs/util/modules/_u8a_tostring_.md @@ -8,7 +8,7 @@ ▸ **u8aToString**(value?: *`Uint8Array` \| `null`*): `string` -*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toString.ts#L35)* +*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toString.ts#L35)* *__name__*: u8aToString diff --git a/docs/util/modules/_u8a_tou8a_.html b/docs/util/modules/_u8a_tou8a_.html index bea26c573..a51869bb1 100644 --- a/docs/util/modules/_u8a_tou8a_.html +++ b/docs/util/modules/_u8a_tou8a_.html @@ -7,7 +7,7 @@ - + @@ -15,11 +15,11 @@ GitHub

Functions

u8aToU8a

▸ u8aToU8a(value?: Array<number> | Buffer | Uint8Array | string | null): Uint8Array

Defined in u8a/toU8a.ts:27

name: u8aToU8a

summary: Creates a Uint8Array value from a Uint8Array bignumber or hex input.

description: null inputs returns a [] result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.

example:

import { u8aToU8a } from '@polkadot/util';
+

Functions

u8aToU8a

▸ u8aToU8a(value?: Array<number> | Buffer | Uint8Array | string | null): Uint8Array

Defined in u8a/toU8a.ts:27

name: u8aToU8a

summary: Creates a Uint8Array value from a Uint8Array bignumber or hex input.

description: null inputs returns a [] result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.

example:

import { u8aToU8a } from '@polkadot/util';
 
 u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
 u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
-
1
2
3
4

Parameters:

Name Type
Optional value Array<number> | Buffer | Uint8Array | string | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:08:42 AM
- +
1
2
3
4

Parameters:

Name Type
Optional value Array<number> | Buffer | Uint8Array | string | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:35:18 AM
+ diff --git a/docs/util/modules/_u8a_tou8a_.md b/docs/util/modules/_u8a_tou8a_.md index a02e75162..b62344688 100644 --- a/docs/util/modules/_u8a_tou8a_.md +++ b/docs/util/modules/_u8a_tou8a_.md @@ -8,7 +8,7 @@ ▸ **u8aToU8a**(value?: *`Array`<`number`> \| `Buffer` \| `Uint8Array` \| `string` \| `null`*): `Uint8Array` -*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/4b1681d/packages/util/src/u8a/toU8a.ts#L27)* +*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/u8a/toU8a.ts#L27)* *__name__*: u8aToU8a diff --git a/lerna.json b/lerna.json index 8f5a1948d..46e1113d0 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.34.26" + "version": "0.34.27" } diff --git a/package.json b/package.json index 5f3f2d9af..71b3a665b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.34.26", + "version": "0.34.27", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/chainspec/package.json b/packages/chainspec/package.json index 00232008a..36159d75d 100644 --- a/packages/chainspec/package.json +++ b/packages/chainspec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/chainspec", - "version": "0.34.26", + "version": "0.34.27", "description": "Contains chain specifications for known chains", "main": "index.js", "keywords": [ @@ -29,6 +29,6 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/chainspec#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/util": "^0.34.26" + "@polkadot/util": "^0.34.27" } } diff --git a/packages/db/package.json b/packages/db/package.json index ef3337792..a929b4276 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/db", - "version": "0.34.26", + "version": "0.34.27", "description": "Implementation of a basic sync in-memory and on-disk databases with overlays", "main": "index.js", "keywords": [ @@ -29,8 +29,8 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/db#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/trie-hash": "^0.34.26", - "@polkadot/util": "^0.34.26", + "@polkadot/trie-hash": "^0.34.27", + "@polkadot/util": "^0.34.27", "@types/mkdirp": "^0.5.2", "@types/rimraf": "^2.0.2", "@types/snappy": "^6.0.0", diff --git a/packages/keyring/package.json b/packages/keyring/package.json index d72b5b804..8dc846eaf 100644 --- a/packages/keyring/package.json +++ b/packages/keyring/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/keyring", - "version": "0.34.26", + "version": "0.34.27", "description": "Keyring management", "main": "index.js", "engines": { @@ -31,8 +31,8 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/util": "^0.34.26", - "@polkadot/util-crypto": "^0.34.26", + "@polkadot/util": "^0.34.27", + "@polkadot/util-crypto": "^0.34.27", "@types/bs58": "^4.0.0", "bs58": "^4.0.1" } diff --git a/packages/trie-codec/package.json b/packages/trie-codec/package.json index b58c38f18..0846f3b6c 100644 --- a/packages/trie-codec/package.json +++ b/packages/trie-codec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-codec", - "version": "0.34.26", + "version": "0.34.27", "description": "This is an implementation of the codec for Substrate Trie", "main": "index.js", "keywords": [ @@ -29,6 +29,6 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-codec#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/util": "^0.34.26" + "@polkadot/util": "^0.34.27" } } diff --git a/packages/trie-db/package.json b/packages/trie-db/package.json index befc2d37b..a6c7cc36f 100644 --- a/packages/trie-db/package.json +++ b/packages/trie-db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-db", - "version": "0.34.26", + "version": "0.34.27", "description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper, adapted for Polkadot", "main": "index.js", "keywords": [ @@ -29,15 +29,15 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-db#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/db": "^0.34.26", - "@polkadot/trie-codec": "^0.34.26", - "@polkadot/trie-hash": "^0.34.26", - "@polkadot/util": "^0.34.26", - "@polkadot/util-crypto": "^0.34.26" + "@polkadot/db": "^0.34.27", + "@polkadot/trie-codec": "^0.34.27", + "@polkadot/trie-hash": "^0.34.27", + "@polkadot/util": "^0.34.27", + "@polkadot/util-crypto": "^0.34.27" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.26", - "@polkadot/util-rlp": "^0.34.26", + "@polkadot/chainspec": "^0.34.27", + "@polkadot/util-rlp": "^0.34.27", "ethereumjs-testing": "1.0.4" } } diff --git a/packages/trie-hash/package.json b/packages/trie-hash/package.json index 07e50df08..1a00e9171 100644 --- a/packages/trie-hash/package.json +++ b/packages/trie-hash/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-hash", - "version": "0.34.26", + "version": "0.34.27", "description": "Generates trie roots from key-value pairs", "main": "index.js", "keywords": [ @@ -29,9 +29,9 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/util": "^0.34.26" + "@polkadot/util": "^0.34.27" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.26" + "@polkadot/chainspec": "^0.34.27" } } diff --git a/packages/util-crypto/package.json b/packages/util-crypto/package.json index 4301eccb5..1ea152a2d 100644 --- a/packages/util-crypto/package.json +++ b/packages/util-crypto/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-crypto", - "version": "0.34.26", + "version": "0.34.27", "description": "A collection of useful crypto utilities for @polkadot", "main": "index.js", "keywords": [ @@ -30,7 +30,7 @@ "dependencies": { "@babel/runtime": "^7.3.1", "@polkadot/schnorrkel-js": "^0.1.2-2", - "@polkadot/util": "^0.34.26", + "@polkadot/util": "^0.34.27", "@types/bip39": "^2.4.2", "@types/secp256k1": "^3.5.0", "@types/webassembly-js-api": "^0.0.2", diff --git a/packages/util-rlp/package.json b/packages/util-rlp/package.json index 14083ee16..3cf2707e0 100644 --- a/packages/util-rlp/package.json +++ b/packages/util-rlp/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-rlp", - "version": "0.34.26", + "version": "0.34.27", "description": "RLP encoding and decoding", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-rlp#readme", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/util": "^0.34.26" + "@polkadot/util": "^0.34.27" }, "devDependencies": { "ethereumjs-testing": "1.0.4" diff --git a/packages/util/package.json b/packages/util/package.json index 5055e96a2..5fc88e2e0 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util", - "version": "0.34.26", + "version": "0.34.27", "description": "A collection of useful utilities for @polkadot", "main": "index.js", "keywords": [