diff --git a/docs/.vuepress/dist/404.html b/docs/.vuepress/dist/404.html deleted file mode 100644 index 0bb95ee11..000000000 --- a/docs/.vuepress/dist/404.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -

404

There's nothing here.
Take me home.
- - - diff --git a/docs/.vuepress/dist/CONTRIBUTING.html b/docs/.vuepress/dist/CONTRIBUTING.html deleted file mode 100644 index b8226d2a4..000000000 --- a/docs/.vuepress/dist/CONTRIBUTING.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Contributing | polkadot-js/common - - - - - - - -
polkadot-js/common

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. -. A pull-request must not be merged until CI has finished successfully.

Merging pull requests once CI is successful:

. A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well. -. No PR should be merged until all reviews' comments are addressed.

.Reviewing pull requests: -When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:

. Buggy behaviour. -. Undue maintenance burden. -. Breaking with house coding style. -. Pessimisation (i.e. reduction of speed as measured in the projects benchmarks). -. 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:38:56 PM

- ← -

- - - diff --git a/docs/.vuepress/dist/assets/css/0.styles.07dd9036.css b/docs/.vuepress/dist/assets/css/0.styles.07dd9036.css deleted file mode 100644 index ea0fddf32..000000000 --- a/docs/.vuepress/dist/assets/css/0.styles.07dd9036.css +++ /dev/null @@ -1 +0,0 @@ -#nprogress{pointer-events:none}#nprogress .bar{background:#fd8824;position:fixed;z-index:1031;top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;-webkit-box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;opacity:1;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px)}#nprogress .spinner{display:block;position:fixed;z-index:1031;top:15px;right:15px}#nprogress .spinner-icon{width:18px;height:18px;-webkit-box-sizing:border-box;box-sizing:border-box;border:2px solid transparent;border-top-color:#fd8824;border-left-color:#fd8824;border-radius:50%;-webkit-animation:nprogress-spinner .4s linear infinite;animation:nprogress-spinner .4s linear infinite}.nprogress-custom-parent{overflow:hidden;position:relative}.nprogress-custom-parent #nprogress .bar,.nprogress-custom-parent #nprogress .spinner{position:absolute}@-webkit-keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}@keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}.icon.outbound{color:#aaa;display:inline-block}.home{padding:3.6rem 2rem 0;max-width:960px;margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.8rem auto}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:#6a8bad}.home .hero .action-button{display:inline-block;font-size:1.2rem;color:#fff;background-color:#fd8824;padding:.8rem 1.6rem;border-radius:4px;-webkit-transition:background-color .1s ease;transition:background-color .1s ease;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #fd7807}.home .hero .action-button:hover{background-color:#fd943a}.home .features{border-top:1px solid #eaecef;padding:1.2rem 0;margin-top:2.5rem;display:-webkit-box;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start;-ms-flex-line-pack:stretch;align-content:stretch;-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.home .feature{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:30%;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:#3a5169}.home .feature p{color:#4e6e8e}.home .footer{padding:2.5rem;border-top:1px solid #eaecef;text-align:center;color:#4e6e8e}@media (max-width:719px){.home .features{-webkit-box-orient:vertical;-webkit-box-direction:normal;-ms-flex-direction:column;flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width:419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.sidebar-button{cursor:pointer;display:none;width:1.25rem;height:1.25rem;position:absolute;padding:.6rem;top:.6rem;left:1rem}.sidebar-button .icon{display:block;width:1.25rem;height:1.25rem}@media (max-width:719px){.sidebar-button{display:block}}.search-box{display:inline-block;position:relative;margin-right:1rem}.search-box input{cursor:text;width:10rem;height:2rem;color:#4e6e8e;display:inline-block;border:1px solid #cfd4db;border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:none;-webkit-transition:all .2s ease;transition:all .2s ease;background:#fff url(/common/assets/img/search.83621669.svg) .6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:#fd8824}.search-box .suggestions{background:#fff;width:20rem;position:absolute;top:1.5rem;border:1px solid #cfd4db;border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestions.align-right{right:0}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion a{white-space:normal;color:#5d82a6}.search-box .suggestion a .page-title{font-weight:600}.search-box .suggestion a .header{font-size:.9em;margin-left:.25em}.search-box .suggestion.focused{background-color:#f3f4f5}.search-box .suggestion.focused a{color:#fd8824}@media (max-width:959px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (-ms-high-contrast:none){.search-box input{height:2rem}}@media (max-width:959px) and (min-width:719px){.search-box .suggestions{left:0}}@media (max-width:719px){.search-box{margin-right:0}.search-box input{left:1rem}.search-box .suggestions{right:0}}@media (max-width:419px){.search-box .suggestions{width:calc(100vw - 4rem)}.search-box input:focus{width:8rem}}.dropdown-enter,.dropdown-leave-to{height:0!important}.dropdown-wrapper{cursor:pointer}.dropdown-wrapper .dropdown-title{display:block}.dropdown-wrapper .dropdown-title:hover{border-color:transparent}.dropdown-wrapper .dropdown-title .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.dropdown-wrapper .nav-dropdown .dropdown-item{color:inherit;line-height:1.7rem}.dropdown-wrapper .nav-dropdown .dropdown-item h4{margin:.45rem 0 0;border-top:1px solid #eee;padding:.45rem 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper{padding:0;list-style:none}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper .dropdown-subitem{font-size:.9em}.dropdown-wrapper .nav-dropdown .dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active,.dropdown-wrapper .nav-dropdown .dropdown-item a:hover{color:#fd8824}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid #fd8824;border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.dropdown-wrapper .nav-dropdown .dropdown-item:first-child h4{margin-top:0;padding-top:0;border-top:0}@media (max-width:719px){.dropdown-wrapper.open .dropdown-title{margin-bottom:.5rem}.dropdown-wrapper .nav-dropdown{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;overflow:hidden}.dropdown-wrapper .nav-dropdown .dropdown-item h4{border-top:0;margin-top:0;padding-top:0}.dropdown-wrapper .nav-dropdown .dropdown-item>a,.dropdown-wrapper .nav-dropdown .dropdown-item h4{font-size:15px;line-height:2rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem{font-size:14px;padding-left:1rem}}@media (min-width:719px){.dropdown-wrapper{height:1.8rem}.dropdown-wrapper:hover .nav-dropdown{display:block!important}.dropdown-wrapper .dropdown-title .arrow{border-left:4px solid transparent;border-right:4px solid transparent;border-top:6px solid #ccc;border-bottom:0}.dropdown-wrapper .nav-dropdown{display:none;height:auto!important;-webkit-box-sizing:border-box;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:#fff;padding:.6rem 0;border:1px solid #ddd;border-bottom-color:#ccc;text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}}.nav-links{display:inline-block}.nav-links a{line-height:1.4rem;color:inherit}.nav-links a.router-link-active,.nav-links a:hover{color:#fd8824}.nav-links .nav-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:2rem}.nav-links .nav-item:first-child{margin-left:0}.nav-links .repo-link{margin-left:1.5rem}@media (max-width:719px){.nav-links .nav-item,.nav-links .repo-link{margin-left:0}}@media (min-width:719px){.nav-links a.router-link-active,.nav-links a:hover{color:#2c3e50}.nav-item>a:not(.external).router-link-active,.nav-item>a:not(.external):hover{margin-bottom:-2px;border-bottom:2px solid #fd9236}}.navbar{padding:.7rem 1.5rem;line-height:2.2rem}.navbar a,.navbar img,.navbar span{display:inline-block}.navbar .logo{height:2.2rem;min-width:2.2rem;margin-right:.8rem;vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:#2c3e50;position:relative}.navbar .links{padding-left:1.5rem;-webkit-box-sizing:border-box;box-sizing:border-box;background-color:#fff;white-space:nowrap;font-size:.9rem;position:absolute;right:1.5rem;top:.7rem;display:-webkit-box;display:-ms-flexbox;display:flex}.navbar .links .search-box{-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;vertical-align:top}@media (max-width:719px){.navbar{padding-left:4rem}.navbar .can-hide{display:none}.navbar .links{padding-left:1.5rem}}.page-edit,.page-nav{max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.page-edit,.page-nav{padding:2rem}}@media (max-width:419px){.page-edit,.page-nav{padding:1.5rem}}.page{padding-bottom:2rem;display:block}.page-edit{padding-top:1rem;padding-bottom:1rem;overflow:auto}.page-edit .edit-link{display:inline-block}.page-edit .edit-link a{color:#4e6e8e;margin-right:.25rem}.page-edit .last-updated{float:right;font-size:.9em}.page-edit .last-updated .prefix{font-weight:500;color:#4e6e8e}.page-edit .last-updated .time{font-weight:400;color:#aaa}.page-nav{padding-top:1rem;padding-bottom:0}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid #eaecef;padding-top:1rem;overflow:auto}.page-nav .next{float:right}@media (max-width:719px){.page-edit .edit-link{margin-bottom:.5rem}.page-edit .last-updated{font-size:.8em;float:none;text-align:left}}.sidebar-group .sidebar-group{padding-left:.5em}.sidebar-group:not(.collapsable) .sidebar-heading:not(.clickable){cursor:auto;color:inherit}.sidebar-group.is-sub-group{padding-left:0}.sidebar-group.is-sub-group>.sidebar-heading{font-size:.95em;line-height:1.4;font-weight:400;padding-left:2rem}.sidebar-group.is-sub-group>.sidebar-heading:not(.clickable){opacity:.5}.sidebar-group.is-sub-group>.sidebar-group-items{padding-left:1rem}.sidebar-group.is-sub-group>.sidebar-group-items>li>.sidebar-link{font-size:.95em;border-left:none}.sidebar-group.depth-2>.sidebar-heading{border-left:none}.sidebar-heading{color:#2c3e50;-webkit-transition:color .15s ease;transition:color .15s ease;cursor:pointer;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box;margin:0;border-left:.25rem solid transparent}.sidebar-heading.open,.sidebar-heading:hover{color:inherit}.sidebar-heading .arrow{position:relative;top:-.12em;left:.5em}.sidebar-heading.clickable.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-heading.clickable:hover{color:#fd8824}.sidebar-group-items{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;font-size:.95em;overflow:hidden}.sidebar .sidebar-sub-headers{padding-left:1rem;font-size:.95em}a.sidebar-link{font-size:1em;font-weight:400;display:inline-block;color:#2c3e50;border-left:.25rem solid transparent;padding:.35rem 1rem .35rem 1.25rem;line-height:1.4;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box}a.sidebar-link:hover{color:#fd8824}a.sidebar-link.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-group a.sidebar-link{padding-left:2rem}.sidebar-sub-headers a.sidebar-link{padding-top:.25rem;padding-bottom:.25rem;border-left:none}.sidebar-sub-headers a.sidebar-link.active{font-weight:500}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .nav-links{display:none;border-bottom:1px solid #eaecef;padding:.5rem 0 .75rem 0}.sidebar .nav-links a{font-weight:600}.sidebar .nav-links .nav-item,.sidebar .nav-links .repo-link{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar>.sidebar-links{padding:1.5rem 0}.sidebar>.sidebar-links>li>a.sidebar-link{font-size:1.1em;line-height:1.7;font-weight:700}.sidebar>.sidebar-links>li:not(:first-child){margin-top:.75rem}@media (max-width:719px){.sidebar .nav-links{display:block}.sidebar .nav-links .dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar>.sidebar-links{padding:1rem 0}}code[class*=language-],pre[class*=language-]{color:#ccc;background:none;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}.content code{color:#476582;padding:.25rem .5rem;margin:0;font-size:.85em;background-color:rgba(27,31,35,.05);border-radius:3px}.content code .token.deleted{color:#ec5975}.content code .token.inserted{color:#fd8824}.content pre,.content pre[class*=language-]{line-height:1.4;padding:1.25rem 1.5rem;margin:.85rem 0;background-color:#282c34;border-radius:6px;overflow:auto}.content pre[class*=language-] code,.content pre code{color:#fff;padding:0;background-color:transparent;border-radius:0}div[class*=language-]{position:relative;background-color:#282c34;border-radius:6px}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.4}div[class*=language-] .highlight-lines .highlighted{background-color:rgba(0,0,0,.66)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:transparent;position:relative;z-index:1}div[class*=language-]:before{position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:hsla(0,0%,100%,.4)}div[class*=language-]:not(.line-numbers-mode) .line-numbers-wrapper{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlighted{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlighted:before{content:" ";position:absolute;z-index:3;left:0;top:0;display:block;width:3.5rem;height:100%;background-color:rgba(0,0,0,.66)}div[class*=language-].line-numbers-mode pre{padding-left:4.5rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers-wrapper{position:absolute;top:0;width:3.5rem;text-align:center;color:hsla(0,0%,100%,.3);padding:1.25rem 0;line-height:1.4}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number,div[class*=language-].line-numbers-mode .line-numbers-wrapper br{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number{position:relative;z-index:4;font-size:.85em}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;z-index:2;top:0;left:0;width:3.5rem;height:100%;border-radius:6px 0 0 6px;border-right:1px solid rgba(0,0,0,.66);background-color:#282c34}div[class~=language-js]:before{content:"js"}div[class~=language-ts]:before{content:"ts"}div[class~=language-html]:before{content:"html"}div[class~=language-md]:before{content:"md"}div[class~=language-vue]:before{content:"vue"}div[class~=language-css]:before{content:"css"}div[class~=language-sass]:before{content:"sass"}div[class~=language-scss]:before{content:"scss"}div[class~=language-less]:before{content:"less"}div[class~=language-stylus]:before{content:"stylus"}div[class~=language-go]:before{content:"go"}div[class~=language-java]:before{content:"java"}div[class~=language-c]:before{content:"c"}div[class~=language-sh]:before{content:"sh"}div[class~=language-yaml]:before{content:"yaml"}div[class~=language-py]:before{content:"py"}div[class~=language-docker]:before{content:"docker"}div[class~=language-dockerfile]:before{content:"dockerfile"}div[class~=language-makefile]:before{content:"makefile"}div[class~=language-javascript]:before{content:"js"}div[class~=language-typescript]:before{content:"ts"}div[class~=language-markup]:before{content:"html"}div[class~=language-markdown]:before{content:"md"}div[class~=language-json]:before{content:"json"}div[class~=language-ruby]:before{content:"rb"}div[class~=language-python]:before{content:"py"}div[class~=language-bash]:before{content:"sh"}div[class~=language-php]:before{content:"php"}.custom-block .custom-block-title{font-weight:600;margin-bottom:-.4rem}.custom-block.danger,.custom-block.tip,.custom-block.warning{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-block.tip{background-color:#f3f5f7;border-color:#42b983}.custom-block.warning{background-color:rgba(255,229,100,.3);border-color:#e7c000;color:#6b5900}.custom-block.warning .custom-block-title{color:#b29400}.custom-block.warning a{color:#2c3e50}.custom-block.danger{background-color:#ffe6e6;border-color:#c00;color:#4d0000}.custom-block.danger .custom-block-title{color:#900}.custom-block.danger a{color:#2c3e50}pre.vue-container{border-left-width:.5rem;border-left-style:solid;border-color:#42b983;border-radius:0}pre.vue-container>code{font-size:14px!important}pre.vue-container>code>p{margin:-5px 0 -20px 0}pre.vue-container>code code{background-color:#42b983!important;padding:3px 5px;border-radius:3px;color:#000}pre.vue-container>code em{color:gray;font-weight:light}.arrow{display:inline-block;width:0;height:0}.arrow.up{border-bottom:6px solid #ccc}.arrow.down,.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent}.arrow.down{border-top:6px solid #ccc}.arrow.right{border-left:6px solid #ccc}.arrow.left,.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent}.arrow.left{border-right:6px solid #ccc}.content:not(.custom){max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.content:not(.custom){padding:2rem}}@media (max-width:419px){.content:not(.custom){padding:1.5rem}}.table-of-contents .badge{vertical-align:middle}body,html{padding:0;margin:0;background-color:#fff}body{font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:16px;color:#2c3e50}.page{padding-left:20rem}.navbar{z-index:20;right:0;height:3.6rem;background-color:#fff;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #eaecef}.navbar,.sidebar-mask{position:fixed;top:0;left:0}.sidebar-mask{z-index:9;width:100vw;height:100vh;display:none}.sidebar{font-size:16px;background-color:#fff;width:20rem;position:fixed;z-index:10;margin:0;top:3.6rem;left:0;bottom:0;-webkit-box-sizing:border-box;box-sizing:border-box;border-right:1px solid #eaecef;overflow-y:auto}.content:not(.custom)>:first-child{margin-top:3.6rem}.content:not(.custom) a:hover{text-decoration:underline}.content:not(.custom) p.demo{padding:1rem 1.5rem;border:1px solid #ddd;border-radius:4px}.content:not(.custom) img{max-width:100%}.content.custom{padding:0;margin:0}.content.custom img{max-width:100%}a{font-weight:500;text-decoration:none}a,p a code{color:#fd8824}p a code{font-weight:400}kbd{background:#eee;border:.15rem solid #ddd;border-bottom:.25rem solid #ddd;border-radius:.15rem;padding:0 .15em}blockquote{font-size:.9rem;color:#999;border-left:.5rem solid #dfe2e5;margin:.5rem 0;padding:.25rem 0 .25rem 1rem}blockquote>p{margin:0}ol,ul{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25}.content:not(.custom)>h1,.content:not(.custom)>h2,.content:not(.custom)>h3,.content:not(.custom)>h4,.content:not(.custom)>h5,.content:not(.custom)>h6{margin-top:-3.1rem;padding-top:4.6rem;margin-bottom:0}.content:not(.custom)>h1:first-child,.content:not(.custom)>h2:first-child,.content:not(.custom)>h3:first-child,.content:not(.custom)>h4:first-child,.content:not(.custom)>h5:first-child,.content:not(.custom)>h6:first-child{margin-top:-1.5rem;margin-bottom:1rem}.content:not(.custom)>h1:first-child+.custom-block,.content:not(.custom)>h1:first-child+p,.content:not(.custom)>h1:first-child+pre,.content:not(.custom)>h2:first-child+.custom-block,.content:not(.custom)>h2:first-child+p,.content:not(.custom)>h2:first-child+pre,.content:not(.custom)>h3:first-child+.custom-block,.content:not(.custom)>h3:first-child+p,.content:not(.custom)>h3:first-child+pre,.content:not(.custom)>h4:first-child+.custom-block,.content:not(.custom)>h4:first-child+p,.content:not(.custom)>h4:first-child+pre,.content:not(.custom)>h5:first-child+.custom-block,.content:not(.custom)>h5:first-child+p,.content:not(.custom)>h5:first-child+pre,.content:not(.custom)>h6:first-child+.custom-block,.content:not(.custom)>h6:first-child+p,.content:not(.custom)>h6:first-child+pre{margin-top:2rem}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid #eaecef}h3{font-size:1.35rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0}a.header-anchor:hover{text-decoration:none}.line-number,code,kbd{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}ol,p,ul{line-height:1.7}hr{border:0;border-top:1px solid #eaecef}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto}tr{border-top:1px solid #dfe2e5}tr:nth-child(2n){background-color:#f6f8fa}td,th{border:1px solid #dfe2e5;padding:.6em 1em}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.no-navbar .content:not(.custom)>h1,.theme-container.no-navbar h2,.theme-container.no-navbar h3,.theme-container.no-navbar h4,.theme-container.no-navbar h5,.theme-container.no-navbar h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .sidebar{top:0}@media (min-width:720px){.theme-container.no-sidebar .sidebar{display:none}.theme-container.no-sidebar .page{padding-left:0}}@media (max-width:959px){.sidebar{font-size:15px;width:16.4rem}.page{padding-left:16.4rem}}@media (max-width:719px){.sidebar{top:0;padding-top:3.6rem;-webkit-transform:translateX(-100%);transform:translateX(-100%);-webkit-transition:-webkit-transform .2s ease;transition:-webkit-transform .2s ease;transition:transform .2s ease;transition:transform .2s ease,-webkit-transform .2s ease}.page{padding-left:0}.theme-container.sidebar-open .sidebar{-webkit-transform:translateX(0);transform:translateX(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width:419px){h1{font-size:1.9rem}.content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.badge[data-v-efceadb8]{display:inline-block;font-size:14px;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:#fff;margin-right:5px;background-color:#42b983}.badge.middle[data-v-efceadb8]{vertical-align:middle}.badge.top[data-v-efceadb8]{vertical-align:top}.badge.green[data-v-efceadb8],.badge.tip[data-v-efceadb8]{background-color:#42b983}.badge.error[data-v-efceadb8]{background-color:#da5961}.badge.warn[data-v-efceadb8],.badge.warning[data-v-efceadb8],.badge.yellow[data-v-efceadb8]{background-color:#e7c000} \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/img/search.83621669.svg b/docs/.vuepress/dist/assets/img/search.83621669.svg deleted file mode 100644 index 03d83913e..000000000 --- a/docs/.vuepress/dist/assets/img/search.83621669.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/.vuepress/dist/assets/js/172.d6fe72c8.js b/docs/.vuepress/dist/assets/js/172.d6fe72c8.js deleted file mode 100644 index 2fff5e35f..000000000 --- a/docs/.vuepress/dist/assets/js/172.d6fe72c8.js +++ /dev/null @@ -1 +0,0 @@ -(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/185.6c3879cf.js b/docs/.vuepress/dist/assets/js/185.6c3879cf.js deleted file mode 100644 index 4346a0301..000000000 --- a/docs/.vuepress/dist/assets/js/185.6c3879cf.js +++ /dev/null @@ -1 +0,0 @@ -(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/2.91658b52.js b/docs/.vuepress/dist/assets/js/2.91658b52.js deleted file mode 100644 index 4726c5e48..000000000 --- a/docs/.vuepress/dist/assets/js/2.91658b52.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[2],{248:function(t,e,n){"use strict";n.d(e,"d",function(){return i}),n.d(e,"a",function(){return r}),n.d(e,"j",function(){return a}),n.d(e,"i",function(){return o}),n.d(e,"f",function(){return u}),n.d(e,"g",function(){return c}),n.d(e,"h",function(){return l}),n.d(e,"b",function(){return h}),n.d(e,"e",function(){return p}),n.d(e,"l",function(){return f}),n.d(e,"m",function(){return d}),n.d(e,"c",function(){return g}),n.d(e,"k",function(){return v});const i=/#.*$/,s=/\.(md|html)$/,r=/\/$/,a=/^(https?:|mailto:|tel:)/;function o(t){return decodeURI(t).replace(i,"").replace(s,"")}function u(t){return a.test(t)}function c(t){return/^mailto:/.test(t)}function l(t){return/^tel:/.test(t)}function h(t){if(u(t))return t;const e=t.match(i),n=e?e[0]:"",s=o(t);return r.test(s)?t:s+".html"+n}function p(t,e){const n=t.hash,s=function(t){const e=t.match(i);if(e)return e[0]}(e);return(!s||n===s)&&o(t.path)===o(e)}function f(t,e,n){n&&(e=function(t,e,n){const i=t.charAt(0);if("/"===i)return t;if("?"===i||"#"===i)return e+t;const s=e.split("/");n&&s[s.length-1]||s.pop();const r=t.replace(/^\//,"").split("/");for(let t=0;t({type:"auto",title:e.title,basePath:t.path,path:t.path+"#"+e.slug,children:e.children||[]}))}]}(t);const o=a.sidebar||r.sidebar;if(o){const{base:t,config:n}=function(t,e){if(Array.isArray(e))return{base:"/",config:e};for(const i in e)if(0===(n=t,/(\.html|\/)$/.test(n)?n:n+"/").indexOf(i))return{base:i,config:e[i]};var n;return{}}(e,o);return n?n.map(e=>(function t(e,n,i,s=1){if("string"==typeof e)return f(n,e,i);if(Array.isArray(e))return Object.assign(f(n,e[0],i),{title:e[1]});{s>3&&console.error("[vuepress] detected a too deep nested sidebar group.");const r=e.children||[];return 0===r.length&&e.path?Object.assign(f(n,e.path,i),{title:e.title}):{type:"group",path:e.path,title:e.title,sidebarDepth:e.sidebarDepth,children:r.map(e=>t(e,n,i,s+1)),collapsable:!1!==e.collapsable}}})(e,s,t)):[]}return[]}function g(t){let e;return(t=t.map(t=>Object.assign({},t))).forEach(t=>{2===t.level?e=t:e&&(e.children||(e.children=[])).push(t)}),t.filter(t=>2===t.level)}function v(t){return Object.assign(t,{type:t.items&&t.items.length?"links":"link"})}},249:function(t,e,n){"use strict";var i=n(8),s=n(66)(3);i(i.P+i.F*!n(47)([].some,!0),"Array",{some:function(t){return s(this,t,arguments[1])}})},251:function(t,e,n){},252:function(t,e,n){},253:function(t,e,n){},254:function(t,e,n){},255:function(t,e,n){},256:function(t,e,n){},257:function(t,e,n){},258:function(t,e,n){},259:function(t,e,n){},260:function(t,e,n){},261:function(t,e,n){},262:function(t,e,n){},263:function(t,e,n){},265:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},266:function(t,e,n){"use strict";var i=n(11),s=n(22),r=n(143),a=n(144);n(145)("match",1,function(t,e,n,o){return[function(n){var i=t(this),s=null==n?void 0:n[e];return void 0!==s?s.call(n,i):new RegExp(n)[e](String(i))},function(t){var e=o(n,t,this);if(e.done)return e.value;var u=i(t),c=String(this);if(!u.global)return a(u,c);var l=u.unicode;u.lastIndex=0;for(var h,p=[],f=0;null!==(h=a(u,c));){var d=String(h[0]);p[f]=d,""===d&&(u.lastIndex=r(c,s(u.lastIndex),l)),f++}return 0===f?null:p}]})},267:function(t,e,n){"use strict";n.r(e);n(249);var i=n(248),s={name:"SidebarGroup",props:["item","open","collapsable","depth"],components:{DropdownTransition:n(268).a},beforeCreate:function(){this.$options.components.SidebarLinks=n(267).default},methods:{isActive:i.e}},r=(n(294),n(46)),a=Object(r.a)(s,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("section",{staticClass:"sidebar-group",class:[{collapsable:t.collapsable,"is-sub-group":0!==t.depth},"depth-"+t.depth]},[t.item.path?n("router-link",{staticClass:"sidebar-heading clickable",class:{open:t.open,active:t.isActive(t.$route,t.item.path)},attrs:{to:t.item.path},nativeOn:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]):n("p",{staticClass:"sidebar-heading",class:{open:t.open},on:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]),t._v(" "),n("DropdownTransition",[t.open||!t.collapsable?n("SidebarLinks",{staticClass:"sidebar-group-items",attrs:{items:t.item.children,sidebarDepth:t.item.sidebarDepth,depth:t.depth+1}}):t._e()],1)],1)},[],!1,null,null,null).exports;n(64);function o(t,e,n,i){return t("router-link",{props:{to:e,activeClass:"",exactActiveClass:""},class:{active:i,"sidebar-link":!0}},n)}function u(t,e,n,s,r){var a=arguments.length>5&&void 0!==arguments[5]?arguments[5]:1;return!e||a>r?null:t("ul",{class:"sidebar-sub-headers"},e.map(function(e){var c=Object(i.e)(s,n+"#"+e.slug);return t("li",{class:"sidebar-sub-header"},[o(t,n+"#"+e.slug,e.title,c),u(t,e.children,n,s,r,a+1)])}))}var c={functional:!0,props:["item","sidebarDepth"],render:function(t,e){var n=e.parent,s=n.$page,r=(n.$site,n.$route),a=n.$themeConfig,c=n.$themeLocaleConfig,l=e.props,h=l.item,p=l.sidebarDepth,f=Object(i.e)(r,h.path),d="auto"===h.type?f||h.children.some(function(t){return Object(i.e)(r,h.basePath+"#"+t.slug)}):f,g=o(t,h.path,h.title||h.path,d),v=s.frontmatter.sidebarDepth||p||c.sidebarDepth||a.sidebarDepth,m=null==v?1:v,b=c.displayAllHeaders||a.displayAllHeaders;return"auto"===h.type?[g,u(t,h.children,h.basePath,r,m)]:(d||b)&&h.headers&&!i.d.test(h.path)?[g,u(t,Object(i.c)(h.headers),h.path,r,m)]:g}};n(295);var l={name:"SidebarLinks",components:{SidebarGroup:a,SidebarLink:Object(r.a)(c,void 0,void 0,!1,null,null,null).exports},props:["items","depth","sidebarDepth"],data:function(){return{openGroupIndex:0}},created:function(){this.refreshIndex()},watch:{$route:function(){this.refreshIndex()}},methods:{refreshIndex:function(){var t=function(t,e){for(var n=0;n-1&&(this.openGroupIndex=t)},toggleGroup:function(t){this.openGroupIndex=t===this.openGroupIndex?-1:t},isActive:function(t){return Object(i.e)(this.$route,t.regularPath)}}},h=Object(r.a)(l,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.items.length?n("ul",{staticClass:"sidebar-links"},t._l(t.items,function(e,i){return n("li",{key:i},["group"===e.type?n("SidebarGroup",{attrs:{item:e,open:i===t.openGroupIndex,collapsable:e.collapsable||e.collapsible,depth:t.depth},on:{toggle:function(e){return t.toggleGroup(i)}}}):n("SidebarLink",{attrs:{sidebarDepth:t.sidebarDepth,item:e}})],1)}),0):t._e()},[],!1,null,null,null);e.default=h.exports},268:function(t,e,n){"use strict";var i={name:"DropdownTransition",methods:{setHeight:function(t){t.style.height=t.scrollHeight+"px"},unsetHeight:function(t){t.style.height=""}}},s=(n(289),n(46)),r=Object(s.a)(i,function(){var t=this.$createElement;return(this._self._c||t)("transition",{attrs:{name:"dropdown"},on:{enter:this.setHeight,"after-enter":this.unsetHeight,"before-leave":this.setHeight}},[this._t("default")],2)},[],!1,null,null,null);e.a=r.exports},270:function(t,e,n){"use strict";n(271)("link",function(t){return function(e){return t(this,"a","href",e)}})},271:function(t,e,n){var i=n(8),s=n(27),r=n(28),a=/"/g,o=function(t,e,n,i){var s=String(r(t)),o="<"+e;return""!==n&&(o+=" "+n+'="'+String(i).replace(a,""")+'"'),o+">"+s+""};t.exports=function(t,e){var n={};n[t]=e(o),i(i.P+i.F*s(function(){var e=""[t]('"');return e!==e.toLowerCase()||e.split('"').length>3}),"String",n)}},272:function(t,e,n){"use strict";var i=n(251);n.n(i).a},273:function(t,e,n){t.exports=n(274)},274:function(t,e,n){n(275),t.exports=n(0).parseInt},275:function(t,e,n){var i=n(1),s=n(276);i(i.G+i.F*(parseInt!=s),{parseInt:s})},276:function(t,e,n){var i=n(3).parseInt,s=n(277).trim,r=n(265),a=/^[-+]?0[xX]/;t.exports=8!==i(r+"08")||22!==i(r+"0x16")?function(t,e){var n=s(String(t),3);return i(n,e>>>0||(a.test(n)?16:10))}:i},277:function(t,e,n){var i=n(1),s=n(67),r=n(16),a=n(265),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},278:function(t,e,n){"use strict";var i=n(252);n.n(i).a},279:function(t,e,n){"use strict";var i=n(8),s=n(139)(!1),r=[].indexOf,a=!!r&&1/[1].indexOf(1,-0)<0;i(i.P+i.F*(a||!n(47)(r)),"Array",{indexOf:function(t){return a?r.apply(this,arguments)||0:s(this,t,arguments[1])}})},280:function(t,e,n){"use strict";n(281)("trim",function(t){return function(){return t(this,3)}})},281:function(t,e,n){var i=n(8),s=n(28),r=n(27),a=n(282),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},282:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},283:function(t,e,n){"use strict";var i=n(253);n.n(i).a},284:function(t,e,n){var i=n(5),s=n(285),r=n(29).f,a=n(288).f,o=n(142),u=n(146),c=i.RegExp,l=c,h=c.prototype,p=/a/g,f=/a/g,d=new c(p)!==p;if(n(21)&&(!d||n(27)(function(){return f[n(2)("match")]=!1,c(p)!=p||c(f)==f||"/a/i"!=c(p,"i")}))){c=function(t,e){var n=this instanceof c,i=o(t),r=void 0===e;return!n&&i&&t.constructor===c&&r?t:s(d?new l(i&&!r?t.source:t,e):l((i=t instanceof c)?t.source:t,i&&r?u.call(t):e),n?this:h,c)};for(var g=function(t){t in c||r(c,t,{configurable:!0,get:function(){return l[t]},set:function(e){l[t]=e}})},v=a(l),m=0;v.length>m;)g(v[m++]);h.constructor=c,c.prototype=h,n(30)(i,"RegExp",c)}n(140)("RegExp")},285:function(t,e,n){var i=n(15),s=n(286).set;t.exports=function(t,e,n){var r,a=e.constructor;return a!==n&&"function"==typeof a&&(r=a.prototype)!==n.prototype&&i(r)&&s&&s(t,r),t}},286:function(t,e,n){var i=n(15),s=n(11),r=function(t,e){if(s(t),!i(e)&&null!==e)throw TypeError(e+": can't set as prototype!")};t.exports={set:Object.setPrototypeOf||("__proto__"in{}?function(t,e,i){try{(i=n(31)(Function.call,n(287).f(Object.prototype,"__proto__").set,2))(t,[]),e=!(t instanceof Array)}catch(t){e=!0}return function(t,n){return r(t,n),e?t.__proto__=n:i(t,n),t}}({},!1):void 0),check:r}},287:function(t,e,n){var i=n(141),s=n(98),r=n(65),a=n(137),o=n(48),u=n(136),c=Object.getOwnPropertyDescriptor;e.f=n(21)?c:function(t,e){if(t=r(t),e=a(e,!0),u)try{return c(t,e)}catch(t){}if(o(t,e))return s(!i.f.call(t,e),t[e])}},288:function(t,e,n){var i=n(138),s=n(99).concat("length","prototype");e.f=Object.getOwnPropertyNames||function(t){return i(t,s)}},289:function(t,e,n){"use strict";var i=n(254);n.n(i).a},290:function(t,e,n){"use strict";var i=n(255);n.n(i).a},291:function(t,e,n){"use strict";var i=n(256);n.n(i).a},292:function(t,e,n){"use strict";var i=n(257);n.n(i).a},293:function(t,e,n){"use strict";var i=n(258);n.n(i).a},294:function(t,e,n){"use strict";var i=n(259);n.n(i).a},295:function(t,e,n){"use strict";var i=n(260);n.n(i).a},296:function(t,e,n){"use strict";var i=n(261);n.n(i).a},297:function(t,e,n){"use strict";var i=n(262);n.n(i).a},298:function(t,e,n){"use strict";var i=n(263);n.n(i).a},300:function(t,e,n){"use strict";n.r(e);var i=n(43),s=n.n(i),r=(n(249),n(270),n(248)),a={props:{item:{required:!0}},computed:{link:function(){return Object(r.b)(this.item.link)},exact:function(){var t=this;return this.$site.locales?s()(this.$site.locales).some(function(e){return e===t.link}):"/"===this.link}},methods:{isExternal:r.f,isMailto:r.g,isTel:r.h}},o=n(46),u=Object(o.a)(a,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.isExternal(t.link)?n("a",{staticClass:"nav-link external",attrs:{href:t.link,target:t.isMailto(t.link)||t.isTel(t.link)?null:"_blank",rel:t.isMailto(t.link)||t.isTel(t.link)?null:"noopener noreferrer"}},[t._v("\n "+t._s(t.item.text)+"\n "),n("OutboundLink")],1):n("router-link",{staticClass:"nav-link",attrs:{to:t.link,exact:t.exact}},[t._v(t._s(t.item.text))])},[],!1,null,null,null).exports,c={components:{NavLink:u},computed:{data:function(){return this.$page.frontmatter},actionLink:function(){return{link:this.data.actionLink,text:this.data.actionText}}}},l=(n(272),Object(o.a)(c,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("main",{staticClass:"home",attrs:{"aria-labelledby":"main-title"}},[n("header",{staticClass:"hero"},[t.data.heroImage?n("img",{attrs:{src:t.$withBase(t.data.heroImage),alt:"hero"}}):t._e(),t._v(" "),n("h1",{attrs:{id:"main-title"}},[t._v(t._s(t.data.heroText||t.$title||"Hello"))]),t._v(" "),n("p",{staticClass:"description"},[t._v("\n "+t._s(t.data.tagline||t.$description||"Welcome to your VuePress site")+"\n ")]),t._v(" "),t.data.actionText&&t.data.actionLink?n("p",{staticClass:"action"},[n("NavLink",{staticClass:"action-button",attrs:{item:t.actionLink}})],1):t._e()]),t._v(" "),t.data.features&&t.data.features.length?n("div",{staticClass:"features"},t._l(t.data.features,function(e,i){return n("div",{key:i,staticClass:"feature"},[n("h2",[t._v(t._s(e.title))]),t._v(" "),n("p",[t._v(t._s(e.details))])])}),0):t._e(),t._v(" "),n("Content",{staticClass:"custom"}),t._v(" "),t.data.footer?n("div",{staticClass:"footer"},[t._v("\n "+t._s(t.data.footer)+"\n ")]):t._e()],1)},[],!1,null,null,null).exports),h=n(273),p=n.n(h),f=(n(278),Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"sidebar-button",on:{click:function(e){return t.$emit("toggle-sidebar")}}},[n("svg",{staticClass:"icon",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",role:"img",viewBox:"0 0 448 512"}},[n("path",{attrs:{fill:"currentColor",d:"M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"}})])])},[],!1,null,null,null).exports),d=(n(266),n(68),n(114)),g=n.n(d),v=n(20),m=n.n(v),b=(n(279),n(280),{data:function(){return{query:"",focused:!1,focusIndex:0}},computed:{showSuggestions:function(){return this.focused&&this.suggestions&&this.suggestions.length},suggestions:function(){var t=this.query.trim().toLowerCase();if(t){for(var e=this.$site.pages,n=this.$localePath,i=function(e){return e.title&&e.title.toLowerCase().indexOf(t)>-1},s=[],r=0;r=5);r++){var a=e[r];if(this.getPageLocalePath(a)===n&&this.isSearchable(a))if(i(a))s.push(a);else if(a.headers)for(var o=0;o=5);o++){var u=a.headers[o];i(u)&&s.push(m()({},a,{path:a.path+"#"+u.slug,header:u}))}}return s}},alignRight:function(){return(this.$site.themeConfig.nav||[]).length+(this.$site.repo?1:0)<=2}},methods:{getPageLocalePath:function(t){for(var e in this.$site.locales||{})if("/"!==e&&0===t.path.indexOf(e))return e;return"/"},isSearchable:function(t){var e=null;return null===e||(e=g()(e)?e:new Array(e)).filter(function(e){return t.path.match(e)}).length>0},onUp:function(){this.showSuggestions&&(this.focusIndex>0?this.focusIndex--:this.focusIndex=this.suggestions.length-1)},onDown:function(){this.showSuggestions&&(this.focusIndex "+t._s(e.header.title))]):t._e()])])}),0):t._e()])},[],!1,null,null,null).exports),k=(n(284),n(61)),x=(n(135),n(64),{components:{NavLink:u,DropdownTransition:n(268).a},data:function(){return{open:!1}},props:{item:{required:!0}},methods:{toggle:function(){this.open=!this.open}}}),$=(n(290),{components:{NavLink:u,DropdownLink:Object(o.a)(x,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"dropdown-wrapper",class:{open:t.open}},[n("a",{staticClass:"dropdown-title",on:{click:t.toggle}},[n("span",{staticClass:"title"},[t._v(t._s(t.item.text))]),t._v(" "),n("span",{staticClass:"arrow",class:t.open?"down":"right"})]),t._v(" "),n("DropdownTransition",[n("ul",{directives:[{name:"show",rawName:"v-show",value:t.open,expression:"open"}],staticClass:"nav-dropdown"},t._l(t.item.items,function(e,i){return n("li",{key:e.link||i,staticClass:"dropdown-item"},["links"===e.type?n("h4",[t._v(t._s(e.text))]):t._e(),t._v(" "),"links"===e.type?n("ul",{staticClass:"dropdown-subitem-wrapper"},t._l(e.items,function(t){return n("li",{key:t.link,staticClass:"dropdown-subitem"},[n("NavLink",{attrs:{item:t}})],1)}),0):n("NavLink",{attrs:{item:e}})],1)}),0)])],1)},[],!1,null,null,null).exports},computed:{userNav:function(){return this.$themeLocaleConfig.nav||this.$site.themeConfig.nav||[]},nav:function(){var t=this,e=this.$site.locales;if(e&&s()(e).length>1){var n=this.$page.path,i=this.$router.options.routes,r=this.$site.themeConfig.locales||{},a={text:this.$themeLocaleConfig.selectText||"Languages",items:s()(e).map(function(s){var a,o=e[s],u=r[s]&&r[s].label||o.lang;return o.lang===t.$lang?a=n:(a=n.replace(t.$localeConfig.path,s),i.some(function(t){return t.path===a})||(a=s)),{text:u,link:a}})};return[].concat(Object(k.a)(this.userNav),[a])}return this.userNav},userLinks:function(){return(this.nav||[]).map(function(t){return m()(Object(r.k)(t),{items:(t.items||[]).map(r.k)})})},repoLink:function(){var t=this.$site.themeConfig.repo;if(t)return/^https?:/.test(t)?t:"https://github.com/".concat(t)},repoLabel:function(){if(this.repoLink){if(this.$site.themeConfig.repoLabel)return this.$site.themeConfig.repoLabel;for(var t=this.repoLink.match(/^https?:\/\/[^\/]+/)[0],e=["GitHub","GitLab","Bitbucket"],n=0;nMath.abs(n)&&Math.abs(e)>40&&(e>0&&this.touchStart.x<=80?this.toggleSidebar(!0):this.toggleSidebar(!1))}}}),T=(n(297),n(298),Object(o.a)(E,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"theme-container",class:t.pageClasses,on:{touchstart:t.onTouchStart,touchend:t.onTouchEnd}},[t.shouldShowNavbar?n("Navbar",{on:{"toggle-sidebar":t.toggleSidebar}}):t._e(),t._v(" "),n("div",{staticClass:"sidebar-mask",on:{click:function(e){return t.toggleSidebar(!1)}}}),t._v(" "),n("Sidebar",{attrs:{items:t.sidebarItems},on:{"toggle-sidebar":t.toggleSidebar}},[t._t("sidebar-top",null,{slot:"top"}),t._v(" "),t._t("sidebar-bottom",null,{slot:"bottom"})],2),t._v(" "),t.$page.frontmatter.home?n("Home"):n("Page",{attrs:{"sidebar-items":t.sidebarItems}},[t._t("page-top",null,{slot:"top"}),t._v(" "),t._t("page-bottom",null,{slot:"bottom"})],2)],1)},[],!1,null,null,null));e.default=T.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 deleted file mode 100644 index 86a890ea5..000000000 --- a/docs/.vuepress/dist/assets/js/222.b6d99e16.js +++ /dev/null @@ -1 +0,0 @@ -(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/223.f814013b.js b/docs/.vuepress/dist/assets/js/223.f814013b.js deleted file mode 100644 index 49a7948f5..000000000 --- a/docs/.vuepress/dist/assets/js/223.f814013b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[223],{322: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 deleted file mode 100644 index 2031007b9..000000000 --- a/docs/.vuepress/dist/assets/js/224.30f758f2.js +++ /dev/null @@ -1 +0,0 @@ -(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/225.93a35929.js b/docs/.vuepress/dist/assets/js/225.93a35929.js deleted file mode 100644 index 64b3045b9..000000000 --- a/docs/.vuepress/dist/assets/js/225.93a35929.js +++ /dev/null @@ -1 +0,0 @@ -(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/226.8dea9412.js b/docs/.vuepress/dist/assets/js/226.8dea9412.js deleted file mode 100644 index 1b2a26fa4..000000000 --- a/docs/.vuepress/dist/assets/js/226.8dea9412.js +++ /dev/null @@ -1 +0,0 @@ -(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/227.0d081bcb.js b/docs/.vuepress/dist/assets/js/227.0d081bcb.js deleted file mode 100644 index 74673d18e..000000000 --- a/docs/.vuepress/dist/assets/js/227.0d081bcb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[227],{319: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.168cc500.js b/docs/.vuepress/dist/assets/js/229.168cc500.js deleted file mode 100644 index 0546a2ab4..000000000 --- a/docs/.vuepress/dist/assets/js/229.168cc500.js +++ /dev/null @@ -1 +0,0 @@ -(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/243.d3bf27af.js b/docs/.vuepress/dist/assets/js/243.d3bf27af.js deleted file mode 100644 index 62bd03485..000000000 --- a/docs/.vuepress/dist/assets/js/243.d3bf27af.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[243],{247:function(n,w,o){}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/3.927f0a66.js b/docs/.vuepress/dist/assets/js/3.927f0a66.js deleted file mode 100644 index 06d13678e..000000000 --- a/docs/.vuepress/dist/assets/js/3.927f0a66.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[3],{264:function(t,e,n){},299:function(t,e,n){"use strict";var a=n(264);n.n(a).a},305:function(t,e,n){"use strict";n.r(e);var a={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,a=e.slots;return t("span",{class:["badge",n.type,n.vertical]},n.text||a().default)}},r=(n(299),n(46)),i=Object(r.a)(a,void 0,void 0,!1,null,"efceadb8",null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/87.c3880025.js b/docs/.vuepress/dist/assets/js/87.c3880025.js deleted file mode 100644 index 1a849aa0e..000000000 --- a/docs/.vuepress/dist/assets/js/87.c3880025.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[87],{504: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/app.1af07c41.js b/docs/.vuepress/dist/assets/js/app.1af07c41.js deleted file mode 100644 index 28676bd94..000000000 --- a/docs/.vuepress/dist/assets/js/app.1af07c41.js +++ /dev/null @@ -1,8 +0,0 @@ -(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(" - - diff --git a/docs/.vuepress/dist/chainspec/index.html b/docs/.vuepress/dist/chainspec/index.html deleted file mode 100644 index 6bf500789..000000000 --- a/docs/.vuepress/dist/chainspec/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html b/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html deleted file mode 100644 index 278fb2594..000000000 --- a/docs/.vuepress/dist/chainspec/modules/_bbqbirch_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html b/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html deleted file mode 100644 index 836ff38fc..000000000 --- a/docs/.vuepress/dist/chainspec/modules/_krummelanke_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/chainspec/modules/_types_.html b/docs/.vuepress/dist/chainspec/modules/_types_.html deleted file mode 100644 index 3f6dc148c..000000000 --- a/docs/.vuepress/dist/chainspec/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/SUMMARY.html b/docs/.vuepress/dist/db/SUMMARY.html deleted file mode 100644 index 5d9b76fcc..000000000 --- a/docs/.vuepress/dist/db/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/classes/_disk_.diskdb.html b/docs/.vuepress/dist/db/classes/_disk_.diskdb.html deleted file mode 100644 index 94ebdccb3..000000000 --- a/docs/.vuepress/dist/db/classes/_disk_.diskdb.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

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';
-
-// Creat diskDb instance that wraps LruDb with backing and Lru cache
-const diskDb = new DiskDb();
-
-// Creat txDb instance that uses diskDb
-const txDb = new TransactionDb(diskDb);
-
-// Open the disk db backing database. Clears the Lru cache
-diskDb.open();
-
-// Declare key/value pair to allocate to store under a the key
-const key = stringToU8a('key');
-const value = stringToU8a('some value');
-
-// Store key/value pair in disk db backing and also in Lru cache
-diskDb.put(key, value);
-
-// Retrieve value for key from disk db. Returns cached value if key
-// in cache, otherwise returns backing value for key and stores
-// this latest retrieved key/value pair in Lru cache
-valueRetrieved = diskDb.get(key);
-
-// Delete key/value pair from disk db backing and set the key to null in Lru cache
-diskDb.del(key);
-
-// Transaction to Store key/value pair in transaction db
-const isTxSuccess = txDb.transaction(() => {
-  txDb.put(key, value);
-
-  // Boolean to indicate whether transaction was successful or not
-  return true;
-});
-
-console.log(`Transaction successful?: ${isTxSuccess}`);
-
-// Retrieve transaction value from diskDb db
-console.log(`Transfered value: ${diskDb.get(key)}`);
-
-// 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: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 deleted file mode 100644 index 07d8f3990..000000000 --- a/docs/.vuepress/dist/db/classes/_engines_filetreedb_.filetreedb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index a82367bc6..000000000 --- a/docs/.vuepress/dist/db/classes/_engines_lrudb_.lrudb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index b65f14793..000000000 --- a/docs/.vuepress/dist/db/classes/_engines_memorydb_.memorydb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 1308b48f3..000000000 --- a/docs/.vuepress/dist/db/classes/_engines_transactiondb_.transactiondb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index a217348d3..000000000 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_cache_.cache.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index e86129fc7..000000000 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_compact_.compact.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index b29f9bd0d..000000000 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_file_.file.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index bdfb3e3e6..000000000 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_impl_.impl.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 0e307531a..000000000 --- a/docs/.vuepress/dist/db/classes/_fileflatdb_serialize_.serialize.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/classes/_memory_.memory.html b/docs/.vuepress/dist/db/classes/_memory_.memory.html deleted file mode 100644 index f84f1d138..000000000 --- a/docs/.vuepress/dist/db/classes/_memory_.memory.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

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';
-
-const memoryDb = new MemoryDb();
-const txDb = new TransactionDb(memoryDb);
-
-// Open the memory database
-memoryDb.open();
-
-// Declare key/value pair to allocate to store under a the key
-const key = stringToU8a('key');
-const value = stringToU8a('some value');
-
-// Store key/value pair in memory db
-memoryDb.put(key, value);
-
-// Retrieve value for key from memory db
-valueRetrieved = memoryDb.get(key);
-
-// Delete key/value pair from memory db
-memoryDb.del(key);
-
-// Transaction to Store key/value pair in transaction db
-const isTxSuccess = txDb.transaction(() => {
-  txDb.put(key, value);
-
-  // Boolean to indicate whether transaction was successful or not
-  return true;
-});
-
-console.log(`Transaction successful?: ${isTxSuccess}`);
-
-// Retrieve transaction value from memory db
-console.log(`Transfered value: ${memoryDb.get(key)}`);
-
-// 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: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 deleted file mode 100644 index d01f33bd0..000000000 --- a/docs/.vuepress/dist/db/enums/_fileflatdb_types_.slot.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/index.html b/docs/.vuepress/dist/db/index.html deleted file mode 100644 index 861b20daa..000000000 --- a/docs/.vuepress/dist/db/index.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index 3cdc1acc2..000000000 --- a/docs/.vuepress/dist/db/interfaces/_types_.basedb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index bf767f6a4..000000000 --- a/docs/.vuepress/dist/db/interfaces/_types_.txdb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 3d79036ca..000000000 --- a/docs/.vuepress/dist/db/modules/_disk_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html b/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html deleted file mode 100644 index 0e42fa62a..000000000 --- a/docs/.vuepress/dist/db/modules/_engines_filetreedb_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_engines_lrudb_.html b/docs/.vuepress/dist/db/modules/_engines_lrudb_.html deleted file mode 100644 index 810625828..000000000 --- a/docs/.vuepress/dist/db/modules/_engines_lrudb_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_engines_memorydb_.html b/docs/.vuepress/dist/db/modules/_engines_memorydb_.html deleted file mode 100644 index 832751acf..000000000 --- a/docs/.vuepress/dist/db/modules/_engines_memorydb_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html b/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html deleted file mode 100644 index 8527357c2..000000000 --- a/docs/.vuepress/dist/db/modules/_engines_transactiondb_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html deleted file mode 100644 index 7ac942494..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_cache_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html deleted file mode 100644 index 495e86bdb..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_compact_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html deleted file mode 100644 index beb6262a5..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html deleted file mode 100644 index 627b13c89..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_file_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html deleted file mode 100644 index 6cc5b7fd7..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_impl_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html deleted file mode 100644 index 95ad4c8bb..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_serialize_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html b/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html deleted file mode 100644 index 742e8cf1c..000000000 --- a/docs/.vuepress/dist/db/modules/_fileflatdb_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index e2c847e20..000000000 --- a/docs/.vuepress/dist/db/modules/_memory_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/db/modules/_types_.html b/docs/.vuepress/dist/db/modules/_types_.html deleted file mode 100644 index c1c20e6e4..000000000 --- a/docs/.vuepress/dist/db/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 364120c29..000000000 --- a/docs/.vuepress/dist/examples/keyring/01_create_account/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Create Account | polkadot-js/common - - - - - - - -
polkadot-js/common

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;
-
-async function main () {
-  // Create account seed for Alice
-  const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-
-  // Create an instance of the Keyring
-  const keyring = new Keyring();
-
-  // Create pair and add Alice to keyring pair dictionary (with account seed)
-  const pairAlice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
-
-  console.log(`Created keyring pair for Alice with address: ` +
-              `${keyring.getPair(pairAlice.address()).address()}`);
-}
-
-main().catch(console.error).finally(_ => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Last Updated: 2/26/2019, 10:14:20 AM

- Load Accounts - - → -

- - - diff --git a/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html b/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html deleted file mode 100644 index edb69c231..000000000 --- a/docs/.vuepress/dist/examples/keyring/02_load_accounts/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Load Accounts | polkadot-js/common - - - - - - - -
polkadot-js/common

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;
-
-async function main () {
-  // Create account seed for Alice and Bob
-  const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-  const BOB_SEED = 'Bob'.padEnd(32, ' ');
-
-  // Create an instance of the Keyring
-  const keyring = new Keyring();
-
-  // Create their pairs with account seeds. Add to keyring pair dictionary
-  keyring.addFromSeed(stringToU8a(ALICE_SEED));
-  keyring.addFromSeed(stringToU8a(BOB_SEED));
-
-  // Note that we did not use `addFromAddress` since it does not add the
-  // secret key to memory so we cannot later retrieve it with `getPairs`
-
-  // Retrieve all keyring pairs from the keyring pair dictionary
-  keyring
-    .getPairs()
-    .forEach((pair, index) => {
-      const address = pair.address();
-
-      console.log(`\nAccount with index #${index} has json: `,
-        JSON.stringify(keyring.toJson(address), null, 2));
-    });
-}
-
-main().catch(console.error).finally(_ => process.exit());
-
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
Last Updated: 2/26/2019, 10:14:20 AM

- ← - - @polkadot/util - - → -

- - - diff --git a/docs/.vuepress/dist/examples/keyring/index.html b/docs/.vuepress/dist/examples/keyring/index.html deleted file mode 100644 index a70c46775..000000000 --- a/docs/.vuepress/dist/examples/keyring/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - Keyring Examples | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 8f5eb6d50..000000000 --- a/docs/.vuepress/dist/examples/trie-db/01_create_patricia_trie/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Create Patricia Trie | polkadot-js/common - - - - - - - - - - - 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 deleted file mode 100644 index a0e010038..000000000 --- a/docs/.vuepress/dist/examples/trie-db/02_get_set_del_trie_nodes/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Get & Set & Delete Trie Nodes | polkadot-js/common - - - - - - - - - - - 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 deleted file mode 100644 index b88b2a9b5..000000000 --- a/docs/.vuepress/dist/examples/trie-db/03_duplicate_trie_with_snapshot/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Duplicate Patricia Trie with Snapshot | polkadot-js/common - - - - - - - - - - - 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 deleted file mode 100644 index cc95cbee9..000000000 --- a/docs/.vuepress/dist/examples/trie-db/04_show_size_trie_node_info/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Show Size and Node Info of a Patricia Trie | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c2c55d5ea..000000000 --- a/docs/.vuepress/dist/examples/trie-db/05_empty_close_drop_trie/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Empty & Close & Drop a Patricia Trie | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/examples/trie-db/index.html b/docs/.vuepress/dist/examples/trie-db/index.html deleted file mode 100644 index f9bec2503..000000000 --- a/docs/.vuepress/dist/examples/trie-db/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - Trie-DB Examples | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 3be137767..000000000 --- a/docs/.vuepress/dist/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Encrypt & Decrypt Message using NaCl | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 1b6a07a71..000000000 --- a/docs/.vuepress/dist/examples/util-crypto/02_sign_verify_message_nacl/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Sign & Verify Message using NaCl | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 391ea8b95..000000000 --- a/docs/.vuepress/dist/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Create & Generate Mnemonic using BIP39 | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/examples/util-crypto/index.html b/docs/.vuepress/dist/examples/util-crypto/index.html deleted file mode 100644 index 223276288..000000000 --- a/docs/.vuepress/dist/examples/util-crypto/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - Util-Crypto Examples | polkadot-js/common - - - - - - - -
polkadot-js/common

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:38:56 PM
- - - diff --git a/docs/.vuepress/dist/index.html b/docs/.vuepress/dist/index.html deleted file mode 100644 index 96a21056a..000000000 --- a/docs/.vuepress/dist/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Polkadot Javascript Common | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 3cd81ecbf..000000000 --- a/docs/.vuepress/dist/keyring/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html b/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html deleted file mode 100644 index ea8c1426d..000000000 --- a/docs/.vuepress/dist/keyring/classes/_pairs_.pairs.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index efdb4c02e..000000000 --- a/docs/.vuepress/dist/keyring/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index 42b57a2d4..000000000 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringinstance.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 4b2b986f4..000000000 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpair.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 358aa46bf..000000000 --- a/docs/.vuepress/dist/keyring/interfaces/_types_.keyringpairs.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 061f6046d..000000000 --- a/docs/.vuepress/dist/keyring/modules/_address_decode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index b85d7b083..000000000 --- a/docs/.vuepress/dist/keyring/modules/_address_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_address_encode_.html b/docs/.vuepress/dist/keyring/modules/_address_encode_.html deleted file mode 100644 index ce55b0acd..000000000 --- a/docs/.vuepress/dist/keyring/modules/_address_encode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 32d47f9e3..000000000 --- a/docs/.vuepress/dist/keyring/modules/_address_setprefix_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_address_types_.html b/docs/.vuepress/dist/keyring/modules/_address_types_.html deleted file mode 100644 index 7aa15d883..000000000 --- a/docs/.vuepress/dist/keyring/modules/_address_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_pair_decode_.html b/docs/.vuepress/dist/keyring/modules/_pair_decode_.html deleted file mode 100644 index e26683b8e..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_decode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index ef02b4954..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_pair_encode_.html b/docs/.vuepress/dist/keyring/modules/_pair_encode_.html deleted file mode 100644 index 4e5bfbc9f..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_encode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 3a5ef7ca5..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_nobody_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html b/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html deleted file mode 100644 index 8b47b23c8..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_tojson_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 9b0b72dd6..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pair_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_pairs_.html b/docs/.vuepress/dist/keyring/modules/_pairs_.html deleted file mode 100644 index 9115a8495..000000000 --- a/docs/.vuepress/dist/keyring/modules/_pairs_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_testing_.html b/docs/.vuepress/dist/keyring/modules/_testing_.html deleted file mode 100644 index 496cc3dda..000000000 --- a/docs/.vuepress/dist/keyring/modules/_testing_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index d6e5b0c77..000000000 --- a/docs/.vuepress/dist/keyring/modules/_testingpairs_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/keyring/modules/_types_.html b/docs/.vuepress/dist/keyring/modules/_types_.html deleted file mode 100644 index ad078962f..000000000 --- a/docs/.vuepress/dist/keyring/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c613b4638..000000000 --- a/docs/.vuepress/dist/trie-codec/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html b/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html deleted file mode 100644 index fd900a2c6..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.branchheader.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 02702ab38..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.extensionheader.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 20ccedd4d..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.leafheader.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 3b037ee5e..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nibbleheader.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index d2e76668a..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.nodeheader.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c462401b4..000000000 --- a/docs/.vuepress/dist/trie-codec/classes/_nodeheader_.null.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/index.html b/docs/.vuepress/dist/trie-codec/index.html deleted file mode 100644 index 97a954de3..000000000 --- a/docs/.vuepress/dist/trie-codec/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_constants_.html b/docs/.vuepress/dist/trie-codec/modules/_constants_.html deleted file mode 100644 index 365f33ee6..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_constants_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Variables | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index cf53cdfbd..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_decode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 41187d785..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_encode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 15b39d8b0..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_hashing_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html deleted file mode 100644 index 2ed61392b..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_nibbles_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 8c77c226e..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_nodeheader_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html deleted file mode 100644 index 3be9a5dc2..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createbranch_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index bd68372d5..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createempty_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html deleted file mode 100644 index 26f7b48b0..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createextension_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html b/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html deleted file mode 100644 index 80701035a..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createleaf_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c2be695d9..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createsubstream_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 82ff6d5c5..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_createvalue_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 613e596d8..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_stream_endbranch_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c6897c688..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html b/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html deleted file mode 100644 index 004ac5823..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_util_fromnibbles_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index e4c485b16..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_util_fusenibbles_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 12c6cbbf3..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_util_sharedprefixlength_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 4bafc7ace..000000000 --- a/docs/.vuepress/dist/trie-codec/modules/_util_tonibbles_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/trie-db/SUMMARY.html b/docs/.vuepress/dist/trie-db/SUMMARY.html deleted file mode 100644 index 2eee7dbac..000000000 --- a/docs/.vuepress/dist/trie-db/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html b/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html deleted file mode 100644 index 647659436..000000000 --- a/docs/.vuepress/dist/trie-db/classes/_checkpoint_.checkpoint.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 5526ec6f2..000000000 --- a/docs/.vuepress/dist/trie-db/classes/_impl_.impl.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index 2f3f6138d..000000000 --- a/docs/.vuepress/dist/trie-db/enums/_types_.nodetype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/index.html b/docs/.vuepress/dist/trie-db/index.html deleted file mode 100644 index 2a112d7b4..000000000 --- a/docs/.vuepress/dist/trie-db/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index 2efc02697..000000000 --- a/docs/.vuepress/dist/trie-db/interfaces/_types_.triedb.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 237b16360..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_checkpoint_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/modules/_constants_.html b/docs/.vuepress/dist/trie-db/modules/_constants_.html deleted file mode 100644 index 97df49e3c..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_constants_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 48b661add..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_ethereumcodec_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/modules/_impl_.html b/docs/.vuepress/dist/trie-db/modules/_impl_.html deleted file mode 100644 index 4dbeb646b..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_impl_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/modules/_types_.html b/docs/.vuepress/dist/trie-db/modules/_types_.html deleted file mode 100644 index e35057f83..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-db/modules/_util_is_.html b/docs/.vuepress/dist/trie-db/modules/_util_is_.html deleted file mode 100644 index f2c3f67c8..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_util_is_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 5117ca3e7..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_util_key_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 0a9f9bb50..000000000 --- a/docs/.vuepress/dist/trie-db/modules/_util_node_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 48adb0576..000000000 --- a/docs/.vuepress/dist/trie-hash/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-hash/index.html b/docs/.vuepress/dist/trie-hash/index.html deleted file mode 100644 index 637765dc7..000000000 --- a/docs/.vuepress/dist/trie-hash/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index 30251454f..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_buildtrie_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index ee6dfad81..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html b/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html deleted file mode 100644 index 058e7da6a..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_trieroot_.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html b/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html deleted file mode 100644 index a93c8f068..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_trierootordered_.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/trie-hash/modules/_types_.html b/docs/.vuepress/dist/trie-hash/modules/_types_.html deleted file mode 100644 index 5bc2596b8..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html b/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html deleted file mode 100644 index 9a2b44635..000000000 --- a/docs/.vuepress/dist/trie-hash/modules/_unhashedtrie_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 0a5690ab8..000000000 --- a/docs/.vuepress/dist/util-crypto/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-crypto/index.html b/docs/.vuepress/dist/util-crypto/index.html deleted file mode 100644 index fbed55bce..000000000 --- a/docs/.vuepress/dist/util-crypto/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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

- ← - - @polkadot/keyring - - → -

- - - diff --git a/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html deleted file mode 100644 index a8c8146e4..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index fc3ae650f..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 2b5de65d1..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index e2834d8fc..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_blake2_blake2b_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 2079b7326..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_keccak_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 3fa9c0501..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_keccak_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 43f0b4916..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_generate_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index d86a6ec36..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_tosecret_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html b/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html deleted file mode 100644 index 69e77e3db..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_toseed_.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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
-
-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: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 deleted file mode 100644 index b61e4d313..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_mnemonic_validate_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 2ae4cda3a..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_decrypt_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 872d44211..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_encrypt_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index b1cb90f8d..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromrandom_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index cda47bdd5..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromsecret_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 710105b46..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromseed_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 2d0db232e..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_keypair_fromstring_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 16deaf772..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_sign_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index d08cac2a8..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_nacl_verify_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 84d48f9c2..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_random_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 8d59ee36d..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_random_asnumber_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 6765c98d1..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_random_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index ab8da608d..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_keypair_fromseed_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 38ae800e0..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_ready_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 043468d26..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_sign_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index ce831befd..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_test_polyfill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html b/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html deleted file mode 100644 index 0606f0405..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_schnorrkel_verify_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index e2c30e4cb..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_secp256k1_recover_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index d3ff5d071..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_sha512_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util-crypto/modules/_types_.html b/docs/.vuepress/dist/util-crypto/modules/_types_.html deleted file mode 100644 index 7fcbb4eef..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html b/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html deleted file mode 100644 index 9afeee0a8..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index bec694682..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_asu8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 46a56504f..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asbn_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index 06044e7ba..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_ashex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index b5cffcbf0..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asraw_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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: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 deleted file mode 100644 index c48114690..000000000 --- a/docs/.vuepress/dist/util-crypto/modules/_xxhash_xxhash64_asvalue_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util-rlp/SUMMARY.html b/docs/.vuepress/dist/util-rlp/SUMMARY.html deleted file mode 100644 index 6f7061e18..000000000 --- a/docs/.vuepress/dist/util-rlp/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/index.html b/docs/.vuepress/dist/util-rlp/index.html deleted file mode 100644 index 4e822902b..000000000 --- a/docs/.vuepress/dist/util-rlp/index.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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 deleted file mode 100644 index d3b1f3d03..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html deleted file mode 100644 index 3f0d347ab..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_decode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html deleted file mode 100644 index f124980f4..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_listlong_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html deleted file mode 100644 index da1f5e67a..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_listshort_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html deleted file mode 100644 index b661a269b..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_number_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html deleted file mode 100644 index ad8df1ad1..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_safeparseint_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html deleted file mode 100644 index f92071561..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_single_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html deleted file mode 100644 index 358c6deb1..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_string_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html b/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html deleted file mode 100644 index 34fe24590..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_decoder_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index f7eb499c4..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encode_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html deleted file mode 100644 index bce44d88c..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_array_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html deleted file mode 100644 index b33d19193..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_length_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index c72a9af22..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_tou8a_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html b/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html deleted file mode 100644 index 4b7b94c39..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index ceeeae60c..000000000 --- a/docs/.vuepress/dist/util-rlp/modules/_encoder_u8a_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 2fa916e8b..000000000 --- a/docs/.vuepress/dist/util/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html b/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html deleted file mode 100644 index 37a2a19c4..000000000 --- a/docs/.vuepress/dist/util/classes/_ext_error_.exterror.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/index.html b/docs/.vuepress/dist/util/index.html deleted file mode 100644 index 66ccca299..000000000 --- a/docs/.vuepress/dist/util/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - -
polkadot-js/common

@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

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

- - - diff --git a/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html b/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html deleted file mode 100644 index f433a841b..000000000 --- a/docs/.vuepress/dist/util/interfaces/_types_.exterrorinterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 2c2acb23a..000000000 --- a/docs/.vuepress/dist/util/interfaces/_types_.tobnoptions.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/common - - - - - - - -
polkadot-js/common

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 deleted file mode 100644 index 58c8dd9c9..000000000 --- a/docs/.vuepress/dist/util/modules/_array_filter_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_assert_.html b/docs/.vuepress/dist/util/modules/_assert_.html deleted file mode 100644 index e65b69d62..000000000 --- a/docs/.vuepress/dist/util/modules/_assert_.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_bn_fromhex_.html b/docs/.vuepress/dist/util/modules/_bn_fromhex_.html deleted file mode 100644 index c15a69303..000000000 --- a/docs/.vuepress/dist/util/modules/_bn_fromhex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_bn_tobn_.html b/docs/.vuepress/dist/util/modules/_bn_tobn_.html deleted file mode 100644 index 17bac4499..000000000 --- a/docs/.vuepress/dist/util/modules/_bn_tobn_.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_bn_tohex_.html b/docs/.vuepress/dist/util/modules/_bn_tohex_.html deleted file mode 100644 index c48a5bb08..000000000 --- a/docs/.vuepress/dist/util/modules/_bn_tohex_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_bn_tou8a_.html b/docs/.vuepress/dist/util/modules/_bn_tou8a_.html deleted file mode 100644 index 6127790b9..000000000 --- a/docs/.vuepress/dist/util/modules/_bn_tou8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html b/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html deleted file mode 100644 index e542f0737..000000000 --- a/docs/.vuepress/dist/util/modules/_buffer_tou8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_compact_addlength_.html b/docs/.vuepress/dist/util/modules/_compact_addlength_.html deleted file mode 100644 index e5eb2c80d..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_addlength_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_compact_defaults_.html b/docs/.vuepress/dist/util/modules/_compact_defaults_.html deleted file mode 100644 index b1a13e13d..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Variables | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html b/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html deleted file mode 100644 index fbdee961c..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_fromu8a_.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_compact_striplength_.html b/docs/.vuepress/dist/util/modules/_compact_striplength_.html deleted file mode 100644 index e3fc8ca70..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_striplength_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_compact_tou8a_.html b/docs/.vuepress/dist/util/modules/_compact_tou8a_.html deleted file mode 100644 index 4f9031583..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_tou8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_compact_types_.html b/docs/.vuepress/dist/util/modules/_compact_types_.html deleted file mode 100644 index e3f46ba6c..000000000 --- a/docs/.vuepress/dist/util/modules/_compact_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_ext_error_.html b/docs/.vuepress/dist/util/modules/_ext_error_.html deleted file mode 100644 index 48d956f29..000000000 --- a/docs/.vuepress/dist/util/modules/_ext_error_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_hex_addprefix_.html b/docs/.vuepress/dist/util/modules/_hex_addprefix_.html deleted file mode 100644 index 056657cb1..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_addprefix_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_fixlength_.html b/docs/.vuepress/dist/util/modules/_hex_fixlength_.html deleted file mode 100644 index 9043e6985..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_fixlength_.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html b/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html deleted file mode 100644 index 0cf6b7bf5..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_hasprefix_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html b/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html deleted file mode 100644 index ad6d767a0..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_stripprefix_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_tobn_.html b/docs/.vuepress/dist/util/modules/_hex_tobn_.html deleted file mode 100644 index 82853f6be..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_tobn_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_tonumber_.html b/docs/.vuepress/dist/util/modules/_hex_tonumber_.html deleted file mode 100644 index a20a5f90b..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_tonumber_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_hex_tou8a_.html b/docs/.vuepress/dist/util/modules/_hex_tou8a_.html deleted file mode 100644 index 9a79d75e9..000000000 --- a/docs/.vuepress/dist/util/modules/_hex_tou8a_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_bn_.html b/docs/.vuepress/dist/util/modules/_is_bn_.html deleted file mode 100644 index 0d3700c5f..000000000 --- a/docs/.vuepress/dist/util/modules/_is_bn_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_boolean_.html b/docs/.vuepress/dist/util/modules/_is_boolean_.html deleted file mode 100644 index ff8277904..000000000 --- a/docs/.vuepress/dist/util/modules/_is_boolean_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_buffer_.html b/docs/.vuepress/dist/util/modules/_is_buffer_.html deleted file mode 100644 index cd1785588..000000000 --- a/docs/.vuepress/dist/util/modules/_is_buffer_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_error_.html b/docs/.vuepress/dist/util/modules/_is_error_.html deleted file mode 100644 index 72f8581db..000000000 --- a/docs/.vuepress/dist/util/modules/_is_error_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_function_.html b/docs/.vuepress/dist/util/modules/_is_function_.html deleted file mode 100644 index 86c58502a..000000000 --- a/docs/.vuepress/dist/util/modules/_is_function_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_hex_.html b/docs/.vuepress/dist/util/modules/_is_hex_.html deleted file mode 100644 index 26cc76f89..000000000 --- a/docs/.vuepress/dist/util/modules/_is_hex_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_instanceof_.html b/docs/.vuepress/dist/util/modules/_is_instanceof_.html deleted file mode 100644 index 0d997c09d..000000000 --- a/docs/.vuepress/dist/util/modules/_is_instanceof_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_ip_.html b/docs/.vuepress/dist/util/modules/_is_ip_.html deleted file mode 100644 index 4116bf7af..000000000 --- a/docs/.vuepress/dist/util/modules/_is_ip_.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_null_.html b/docs/.vuepress/dist/util/modules/_is_null_.html deleted file mode 100644 index dc658f22d..000000000 --- a/docs/.vuepress/dist/util/modules/_is_null_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_number_.html b/docs/.vuepress/dist/util/modules/_is_number_.html deleted file mode 100644 index 086f7e11f..000000000 --- a/docs/.vuepress/dist/util/modules/_is_number_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_object_.html b/docs/.vuepress/dist/util/modules/_is_object_.html deleted file mode 100644 index 22292b6d6..000000000 --- a/docs/.vuepress/dist/util/modules/_is_object_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_observable_.html b/docs/.vuepress/dist/util/modules/_is_observable_.html deleted file mode 100644 index 17dfc756e..000000000 --- a/docs/.vuepress/dist/util/modules/_is_observable_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_string_.html b/docs/.vuepress/dist/util/modules/_is_string_.html deleted file mode 100644 index 8a90cf17d..000000000 --- a/docs/.vuepress/dist/util/modules/_is_string_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_u8a_.html b/docs/.vuepress/dist/util/modules/_is_u8a_.html deleted file mode 100644 index 141d7de16..000000000 --- a/docs/.vuepress/dist/util/modules/_is_u8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_is_undefined_.html b/docs/.vuepress/dist/util/modules/_is_undefined_.html deleted file mode 100644 index 7358fd508..000000000 --- a/docs/.vuepress/dist/util/modules/_is_undefined_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_logger_.html b/docs/.vuepress/dist/util/modules/_logger_.html deleted file mode 100644 index 496140c1f..000000000 --- a/docs/.vuepress/dist/util/modules/_logger_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_number_tohex_.html b/docs/.vuepress/dist/util/modules/_number_tohex_.html deleted file mode 100644 index 6e29b0a68..000000000 --- a/docs/.vuepress/dist/util/modules/_number_tohex_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_number_tou8a_.html b/docs/.vuepress/dist/util/modules/_number_tou8a_.html deleted file mode 100644 index 3039a8774..000000000 --- a/docs/.vuepress/dist/util/modules/_number_tou8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_fill_.html b/docs/.vuepress/dist/util/modules/_polyfill_fill_.html deleted file mode 100644 index de9e21e5d..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_fill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_padend_.html b/docs/.vuepress/dist/util/modules/_polyfill_padend_.html deleted file mode 100644 index f539854e6..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_padend_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html b/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html deleted file mode 100644 index 2e5bd2f1f..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_padstart_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html b/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html deleted file mode 100644 index 077b40553..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_setprototypeof_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html b/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html deleted file mode 100644 index f6bc5b1a6..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_textdecoder_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html b/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html deleted file mode 100644 index 59beaa7b4..000000000 --- a/docs/.vuepress/dist/util/modules/_polyfill_textencoder_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_promisify_.html b/docs/.vuepress/dist/util/modules/_promisify_.html deleted file mode 100644 index a2ff90291..000000000 --- a/docs/.vuepress/dist/util/modules/_promisify_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_string_camelcase_.html b/docs/.vuepress/dist/util/modules/_string_camelcase_.html deleted file mode 100644 index 1cd1bf99a..000000000 --- a/docs/.vuepress/dist/util/modules/_string_camelcase_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html b/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html deleted file mode 100644 index 3703daca2..000000000 --- a/docs/.vuepress/dist/util/modules/_string_lowerfirst_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_string_shorten_.html b/docs/.vuepress/dist/util/modules/_string_shorten_.html deleted file mode 100644 index 48152d317..000000000 --- a/docs/.vuepress/dist/util/modules/_string_shorten_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_string_tou8a_.html b/docs/.vuepress/dist/util/modules/_string_tou8a_.html deleted file mode 100644 index 5232134f0..000000000 --- a/docs/.vuepress/dist/util/modules/_string_tou8a_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_string_upperfirst_.html b/docs/.vuepress/dist/util/modules/_string_upperfirst_.html deleted file mode 100644 index 19e7d69aa..000000000 --- a/docs/.vuepress/dist/util/modules/_string_upperfirst_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_syncify_.html b/docs/.vuepress/dist/util/modules/_syncify_.html deleted file mode 100644 index f9f52bca9..000000000 --- a/docs/.vuepress/dist/util/modules/_syncify_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_types_.html b/docs/.vuepress/dist/util/modules/_types_.html deleted file mode 100644 index b252d2da4..000000000 --- a/docs/.vuepress/dist/util/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/common - - - - - - - - - - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_concat_.html b/docs/.vuepress/dist/util/modules/_u8a_concat_.html deleted file mode 100644 index 402e0a961..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_concat_.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html b/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html deleted file mode 100644 index e509030b1..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_fixlength_.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_tobn_.html b/docs/.vuepress/dist/util/modules/_u8a_tobn_.html deleted file mode 100644 index 2ee815f8b..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_tobn_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html b/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html deleted file mode 100644 index e7289b76b..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_tobuffer_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_tohex_.html b/docs/.vuepress/dist/util/modules/_u8a_tohex_.html deleted file mode 100644 index a93890bb1..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_tohex_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_tostring_.html b/docs/.vuepress/dist/util/modules/_u8a_tostring_.html deleted file mode 100644 index b9a0b382a..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_tostring_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html b/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html deleted file mode 100644 index a51869bb1..000000000 --- a/docs/.vuepress/dist/util/modules/_u8a_tou8a_.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - Functions | polkadot-js/common - - - - - - - -
polkadot-js/common

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:35:18 AM
- - - diff --git a/docs/404.html b/docs/404.html index 0bb95ee11..461bb668d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -7,11 +7,11 @@ - + -

404

There's nothing here.
Take me home.
- +

404

Looks like we've got some broken links.
Take me home.
+ diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index b8226d2a4..7ce94d2a3 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -7,7 +7,7 @@ - + @@ -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:38:56 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, 5:00:38 PM

←

- + diff --git a/docs/.vuepress/dist/assets/js/10.e3de6e32.js b/docs/assets/js/10.aeb7946d.js similarity index 58% rename from docs/.vuepress/dist/assets/js/10.e3de6e32.js rename to docs/assets/js/10.aeb7946d.js index b3f073ac4..ed1f104ab 100644 --- a/docs/.vuepress/dist/assets/js/10.e3de6e32.js +++ b/docs/assets/js/10.aeb7946d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{388: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([[10],{368:function(t,e,n){"use strict";n.r(e);var s=n(37),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/100.eada1ee7.js b/docs/assets/js/100.fa71143a.js similarity index 88% rename from docs/.vuepress/dist/assets/js/100.eada1ee7.js rename to docs/assets/js/100.fa71143a.js index c2c0157b3..b6e4adc29 100644 --- a/docs/.vuepress/dist/assets/js/100.eada1ee7.js +++ b/docs/assets/js/100.fa71143a.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{465:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.c0266c71.js b/docs/assets/js/101.a30f1648.js similarity index 94% rename from docs/.vuepress/dist/assets/js/101.c0266c71.js rename to docs/assets/js/101.a30f1648.js index ab64f471b..64820a247 100644 --- a/docs/.vuepress/dist/assets/js/101.c0266c71.js +++ b/docs/assets/js/101.a30f1648.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{463:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.bbdf1551.js b/docs/assets/js/102.726d4588.js similarity index 94% rename from docs/.vuepress/dist/assets/js/102.bbdf1551.js rename to docs/assets/js/102.726d4588.js index ab284fe06..359aff007 100644 --- a/docs/.vuepress/dist/assets/js/102.bbdf1551.js +++ b/docs/assets/js/102.726d4588.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{462:function(t,e,a){"use strict";a.r(e);var s=a(37),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/103.2b40a00a.js b/docs/assets/js/103.db6e07bb.js similarity index 92% rename from docs/.vuepress/dist/assets/js/103.2b40a00a.js rename to docs/assets/js/103.db6e07bb.js index af6f5d496..3f01903b6 100644 --- a/docs/.vuepress/dist/assets/js/103.2b40a00a.js +++ b/docs/assets/js/103.db6e07bb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{480:function(t,e,l){"use strict";l.r(e);var r=l(46),i=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:"/trie-db/modules/_checkpoint_.html"}},[t._v('"Checkpoint"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_impl_.html"}},[t._v('"Impl"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_constants_.html"}},[t._v('"constants"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_ethereumcodec_.html"}},[t._v('"ethereumCodec"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[t._v("NodeType")])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_is_.html"}},[t._v('"util/is"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_key_.html"}},[t._v('"util/key"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_node_.html"}},[t._v('"util/node"')])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{460:function(t,e,l){"use strict";l.r(e);var r=l(37),i=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:"/trie-db/modules/_checkpoint_.html"}},[t._v('"Checkpoint"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_impl_.html"}},[t._v('"Impl"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/classes/_impl_.impl.html"}},[t._v("Impl")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_constants_.html"}},[t._v('"constants"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_ethereumcodec_.html"}},[t._v('"ethereumCodec"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),l("ul",[l("li",[l("router-link",{attrs:{to:"/trie-db/enums/_types_.nodetype.html"}},[t._v("NodeType")])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/interfaces/_types_.triedb.html"}},[t._v("TrieDb")])],1)])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_is_.html"}},[t._v('"util/is"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_key_.html"}},[t._v('"util/key"')])],1),t._v(" "),l("li",[l("router-link",{attrs:{to:"/trie-db/modules/_util_node_.html"}},[t._v('"util/node"')])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/104.08626032.js b/docs/assets/js/104.67557f12.js similarity index 90% rename from docs/.vuepress/dist/assets/js/104.08626032.js rename to docs/assets/js/104.67557f12.js index 34b7c728d..d5396ba6b 100644 --- a/docs/.vuepress/dist/assets/js/104.08626032.js +++ b/docs/assets/js/104.67557f12.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{459:function(t,r,e){"use strict";e.r(r);var o=e(37),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/6506c10/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.3756f026.js b/docs/assets/js/105.83ff9d05.js similarity index 93% rename from docs/.vuepress/dist/assets/js/105.3756f026.js rename to docs/assets/js/105.83ff9d05.js index 8fb932bfa..1108b49d2 100644 --- a/docs/.vuepress/dist/assets/js/105.3756f026.js +++ b/docs/assets/js/105.83ff9d05.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{457:function(t,r,e){"use strict";e.r(r);var a=e(37),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/6506c10/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/6506c10/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.9b5387d2.js b/docs/assets/js/106.ad3268dc.js similarity index 88% rename from docs/.vuepress/dist/assets/js/106.9b5387d2.js rename to docs/assets/js/106.ad3268dc.js index dfeb9b547..0d4161234 100644 --- a/docs/.vuepress/dist/assets/js/106.9b5387d2.js +++ b/docs/assets/js/106.ad3268dc.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{456:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.ac0410cf.js b/docs/assets/js/107.476987e9.js similarity index 91% rename from docs/.vuepress/dist/assets/js/107.ac0410cf.js rename to docs/assets/js/107.476987e9.js index 664efa390..057adfa95 100644 --- a/docs/.vuepress/dist/assets/js/107.ac0410cf.js +++ b/docs/assets/js/107.476987e9.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{454:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/108.4b0bb2fe.js b/docs/assets/js/108.c5dc9af6.js similarity index 82% rename from docs/.vuepress/dist/assets/js/108.4b0bb2fe.js rename to docs/assets/js/108.c5dc9af6.js index 8157e439a..c6f25428f 100644 --- a/docs/.vuepress/dist/assets/js/108.4b0bb2fe.js +++ b/docs/assets/js/108.c5dc9af6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{539: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:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{519:function(t,e,s){"use strict";s.r(e);var a=s(37),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:"/trie-db/classes/_checkpoint_.checkpoint.html"}},[t._v("Checkpoint")])],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/109.f796e243.js b/docs/assets/js/109.d67ef8d0.js similarity index 89% rename from docs/.vuepress/dist/assets/js/109.f796e243.js rename to docs/assets/js/109.d67ef8d0.js index bb5b05912..271e0ba34 100644 --- a/docs/.vuepress/dist/assets/js/109.f796e243.js +++ b/docs/assets/js/109.d67ef8d0.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{450:function(t,e,a){"use strict";a.r(e);var s=a(37),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/6506c10/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/6506c10/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.ea4175ac.js b/docs/assets/js/11.9db1ea70.js similarity index 84% rename from docs/.vuepress/dist/assets/js/11.ea4175ac.js rename to docs/assets/js/11.9db1ea70.js index 1c6570dee..799465917 100644 --- a/docs/.vuepress/dist/assets/js/11.ea4175ac.js +++ b/docs/assets/js/11.9db1ea70.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{371:function(e,t,a){"use strict";a.r(t);var s=a(37),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/6506c10/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/110.a164004c.js b/docs/assets/js/110.440ef496.js similarity index 58% rename from docs/.vuepress/dist/assets/js/110.a164004c.js rename to docs/assets/js/110.440ef496.js index 33635bb0b..8074b66f6 100644 --- a/docs/.vuepress/dist/assets/js/110.a164004c.js +++ b/docs/assets/js/110.440ef496.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{470: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([[110],{451:function(t,e,n){"use strict";n.r(e);var s=n(37),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/111.b00ef71d.js b/docs/assets/js/111.72331224.js similarity index 82% rename from docs/.vuepress/dist/assets/js/111.b00ef71d.js rename to docs/assets/js/111.72331224.js index 73e08e579..e88fa8830 100644 --- a/docs/.vuepress/dist/assets/js/111.b00ef71d.js +++ b/docs/assets/js/111.72331224.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{448:function(t,s,e){"use strict";e.r(s);var a=e(37),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.3bdcdd17.js b/docs/assets/js/112.fe4db84c.js similarity index 93% rename from docs/.vuepress/dist/assets/js/112.3bdcdd17.js rename to docs/assets/js/112.fe4db84c.js index d2abcfb46..2a5249a3d 100644 --- a/docs/.vuepress/dist/assets/js/112.3bdcdd17.js +++ b/docs/assets/js/112.fe4db84c.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{447:function(e,t,r){"use strict";r.r(t);var o=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.a1e71949.js b/docs/assets/js/113.80e15741.js similarity index 93% rename from docs/.vuepress/dist/assets/js/113.a1e71949.js rename to docs/assets/js/113.80e15741.js index bdad21d06..cdfc33071 100644 --- a/docs/.vuepress/dist/assets/js/113.a1e71949.js +++ b/docs/assets/js/113.80e15741.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{445:function(e,t,r){"use strict";r.r(t);var o=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.e6b445cc.js b/docs/assets/js/114.82d6355e.js similarity index 92% rename from docs/.vuepress/dist/assets/js/114.e6b445cc.js rename to docs/assets/js/114.82d6355e.js index 126f528a0..ed3b15829 100644 --- a/docs/.vuepress/dist/assets/js/114.e6b445cc.js +++ b/docs/assets/js/114.82d6355e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{444:function(t,e,r){"use strict";r.r(e);var _=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.62463929.js b/docs/assets/js/115.b85988d2.js similarity index 92% rename from docs/.vuepress/dist/assets/js/115.62463929.js rename to docs/assets/js/115.b85988d2.js index cfe8fd4c6..f7d83d388 100644 --- a/docs/.vuepress/dist/assets/js/115.62463929.js +++ b/docs/assets/js/115.b85988d2.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{442:function(e,t,o){"use strict";o.r(t);var r=o(37),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/6506c10/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/6506c10/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/6506c10/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/116.1dd89c9b.js b/docs/assets/js/116.cd78d195.js similarity index 94% rename from docs/.vuepress/dist/assets/js/116.1dd89c9b.js rename to docs/assets/js/116.cd78d195.js index dc9d6ea9d..1ab8c3d98 100644 --- a/docs/.vuepress/dist/assets/js/116.1dd89c9b.js +++ b/docs/assets/js/116.cd78d195.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{461: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:"polkadot-trie-hash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-hash","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-hash")]),t._v(" "),e("p",[t._v("Calculate ordered and unordered "),e("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree",target:"_blank",rel:"noopener noreferrer"}},[t._v("Trie hashes"),e("OutboundLink")],1),t._v(" from inputs.")]),t._v(" "),e("h2",{attrs:{id:"usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),e("p",[t._v("Installation -")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("yarn add @polkadot/trie-hash\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Functions can be imported as follows:")]),t._v(" "),e("div",{staticClass:"language-js line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[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(" trieRoot "),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/trie-hash'")]),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("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/trie-hash/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([[116],{441:function(t,a,e){"use strict";e.r(a);var s=e(37),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:"polkadot-trie-hash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-hash","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-hash")]),t._v(" "),e("p",[t._v("Calculate ordered and unordered "),e("a",{attrs:{href:"https://github.com/ethereum/wiki/wiki/Patricia-Tree",target:"_blank",rel:"noopener noreferrer"}},[t._v("Trie hashes"),e("OutboundLink")],1),t._v(" from inputs.")]),t._v(" "),e("h2",{attrs:{id:"usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),e("p",[t._v("Installation -")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("yarn add @polkadot/trie-hash\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Functions can be imported as follows:")]),t._v(" "),e("div",{staticClass:"language-js line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[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(" trieRoot "),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/trie-hash'")]),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("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/trie-hash/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/117.85c78ed2.js b/docs/assets/js/117.17ee0294.js similarity index 87% rename from docs/.vuepress/dist/assets/js/117.85c78ed2.js rename to docs/assets/js/117.17ee0294.js index d2fa92146..6bbd26a41 100644 --- a/docs/.vuepress/dist/assets/js/117.85c78ed2.js +++ b/docs/assets/js/117.17ee0294.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{459:function(t,e,r){"use strict";r.r(e);var l=r(46),o=Object(l.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_buildtrie_.html"}},[t._v('"buildTrie"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_defaults_.html"}},[t._v('"defaults"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_trieroot_.html"}},[t._v('"trieRoot"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_trierootordered_.html"}},[t._v('"trieRootOrdered"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html"}},[t._v('"types"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_unhashedtrie_.html"}},[t._v('"unhashedTrie"')])],1)])])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{438:function(t,e,r){"use strict";r.r(e);var l=r(37),o=Object(l.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_buildtrie_.html"}},[t._v('"buildTrie"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_defaults_.html"}},[t._v('"defaults"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_trieroot_.html"}},[t._v('"trieRoot"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_trierootordered_.html"}},[t._v('"trieRootOrdered"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_types_.html"}},[t._v('"types"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-hash/modules/_unhashedtrie_.html"}},[t._v('"unhashedTrie"')])],1)])])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/118.cc136900.js b/docs/assets/js/118.4ef3fef9.js similarity index 89% rename from docs/.vuepress/dist/assets/js/118.cc136900.js rename to docs/assets/js/118.4ef3fef9.js index 112484c20..014f6f09d 100644 --- a/docs/.vuepress/dist/assets/js/118.cc136900.js +++ b/docs/assets/js/118.4ef3fef9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{453:function(t,e,r){"use strict";r.r(e);var v=r(37),_=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/6506c10/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.294e232e.js b/docs/assets/js/119.d4ee97b2.js similarity index 58% rename from docs/.vuepress/dist/assets/js/119.294e232e.js rename to docs/assets/js/119.d4ee97b2.js index a72c97da2..deb3f56b3 100644 --- a/docs/.vuepress/dist/assets/js/119.294e232e.js +++ b/docs/assets/js/119.d4ee97b2.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{433:function(t,e,n){"use strict";n.r(e);var s=n(37),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/12.42d95e86.js b/docs/assets/js/12.ed1926ae.js similarity index 95% rename from docs/.vuepress/dist/assets/js/12.42d95e86.js rename to docs/assets/js/12.ed1926ae.js index e4f5b6fec..f095ff7f8 100644 --- a/docs/.vuepress/dist/assets/js/12.42d95e86.js +++ b/docs/assets/js/12.ed1926ae.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{394:function(s,t,a){"use strict";a.r(t);var e=a(46),r=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:"polkadot-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-db","aria-hidden":"true"}},[s._v("#")]),s._v(" @polkadot/db")]),s._v(" "),a("p",[s._v("This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client")]),s._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[s._v("#")]),s._v(" Usage")]),s._v(" "),a("p",[s._v("Installation -")]),s._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[s._v("yarn add @polkadot/db\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br")])]),a("p",[s._v("Classes can be imported as follows:")]),s._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"}},[s._v("// Default exports")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" DiskDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/Disk'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" MemoryDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/Memory'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" TransactionDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/engines/TransactionDb'")]),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("span",{staticClass:"line-number"},[s._v("4")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[s._v("#")]),s._v(" Utilities")]),s._v(" "),a("p",[a("router-link",{attrs:{to:"/db/SUMMARY.html"}},[s._v("Utilities")])],1)])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{374:function(s,t,a){"use strict";a.r(t);var e=a(37),r=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:"polkadot-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-db","aria-hidden":"true"}},[s._v("#")]),s._v(" @polkadot/db")]),s._v(" "),a("p",[s._v("This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client")]),s._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[s._v("#")]),s._v(" Usage")]),s._v(" "),a("p",[s._v("Installation -")]),s._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[s._v("yarn add @polkadot/db\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br")])]),a("p",[s._v("Classes can be imported as follows:")]),s._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"}},[s._v("// Default exports")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" DiskDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/Disk'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" MemoryDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/Memory'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" TransactionDb "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/db/engines/TransactionDb'")]),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("span",{staticClass:"line-number"},[s._v("4")]),a("br")])]),a("h2",{attrs:{id:"utilities"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[s._v("#")]),s._v(" Utilities")]),s._v(" "),a("p",[a("router-link",{attrs:{to:"/db/SUMMARY.html"}},[s._v("Utilities")])],1)])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/120.83f82f71.js b/docs/assets/js/120.a17946a3.js similarity index 96% rename from docs/.vuepress/dist/assets/js/120.83f82f71.js rename to docs/assets/js/120.a17946a3.js index 3fbf5dff2..4c83dea5b 100644 --- a/docs/.vuepress/dist/assets/js/120.83f82f71.js +++ b/docs/assets/js/120.a17946a3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{435:function(t,a,s){"use strict";s.r(a);var r=s(37),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/6506c10/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.b9ffa863.js b/docs/assets/js/121.96be6a8e.js similarity index 96% rename from docs/.vuepress/dist/assets/js/121.b9ffa863.js rename to docs/assets/js/121.96be6a8e.js index d67df6653..bfce80f57 100644 --- a/docs/.vuepress/dist/assets/js/121.b9ffa863.js +++ b/docs/assets/js/121.96be6a8e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{432:function(t,e,a){"use strict";a.r(e);var s=a(37),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/6506c10/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.4129636d.js b/docs/assets/js/122.2fa0d758.js similarity index 84% rename from docs/.vuepress/dist/assets/js/122.4129636d.js rename to docs/assets/js/122.2fa0d758.js index a1bbbb1e7..899672da2 100644 --- a/docs/.vuepress/dist/assets/js/122.4129636d.js +++ b/docs/assets/js/122.2fa0d758.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{430:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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.390c7af8.js b/docs/assets/js/123.88514f8a.js similarity index 90% rename from docs/.vuepress/dist/assets/js/123.390c7af8.js rename to docs/assets/js/123.88514f8a.js index 520df0469..6d86f893b 100644 --- a/docs/.vuepress/dist/assets/js/123.390c7af8.js +++ b/docs/assets/js/123.88514f8a.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{429:function(t,e,r){"use strict";r.r(e);var a=r(37),_=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/6506c10/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/124.bf8a9f43.js b/docs/assets/js/124.f74cd9ad.js similarity index 94% rename from docs/.vuepress/dist/assets/js/124.bf8a9f43.js rename to docs/assets/js/124.f74cd9ad.js index 9d890a2a1..97c0fac88 100644 --- a/docs/.vuepress/dist/assets/js/124.bf8a9f43.js +++ b/docs/assets/js/124.f74cd9ad.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{447: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-crypto"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util-crypto","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util-crypto")]),t._v(" "),s("p",[t._v("Various useful cyrpto 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-crypto\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 as follows:")]),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(" mnemonicGenerate "),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")])]),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-crypto/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([[124],{427:function(t,a,s){"use strict";s.r(a);var e=s(37),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-crypto"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-util-crypto","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/util-crypto")]),t._v(" "),s("p",[t._v("Various useful cyrpto 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-crypto\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 as follows:")]),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(" mnemonicGenerate "),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")])]),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-crypto/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/125.f7a60723.js b/docs/assets/js/125.0a97266f.js similarity index 97% rename from docs/.vuepress/dist/assets/js/125.f7a60723.js rename to docs/assets/js/125.0a97266f.js index 49e49e982..1a9c91d26 100644 --- a/docs/.vuepress/dist/assets/js/125.f7a60723.js +++ b/docs/assets/js/125.0a97266f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[125],{446:function(t,l,r){"use strict";r.r(l);var o=r(46),e=Object(o.a)({},function(){var t=this,l=t.$createElement,r=t._self._c||l;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_ashex_.html"}},[t._v('"blake2/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_asu8a_.html"}},[t._v('"blake2/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_blake2b_ashex_.html"}},[t._v('"blake2/blake2b/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_blake2b_asu8a_.html"}},[t._v('"blake2/blake2b/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_keccak_ashex_.html"}},[t._v('"keccak/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_keccak_asu8a_.html"}},[t._v('"keccak/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_generate_.html"}},[t._v('"mnemonic/generate"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_tosecret_.html"}},[t._v('"mnemonic/toSecret"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_toseed_.html"}},[t._v('"mnemonic/toSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_validate_.html"}},[t._v('"mnemonic/validate"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_decrypt_.html"}},[t._v('"nacl/decrypt"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_encrypt_.html"}},[t._v('"nacl/encrypt"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromrandom_.html"}},[t._v('"nacl/keypair/fromRandom"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromsecret_.html"}},[t._v('"nacl/keypair/fromSecret"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromseed_.html"}},[t._v('"nacl/keypair/fromSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromstring_.html"}},[t._v('"nacl/keypair/fromString"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_sign_.html"}},[t._v('"nacl/sign"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_verify_.html"}},[t._v('"nacl/verify"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_ashex_.html"}},[t._v('"random/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_asnumber_.html"}},[t._v('"random/asNumber"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_asu8a_.html"}},[t._v('"random/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_keypair_fromseed_.html"}},[t._v('"schnorrkel/keypair/fromSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_ready_.html"}},[t._v('"schnorrkel/ready"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_sign_.html"}},[t._v('"schnorrkel/sign"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_test_polyfill_.html"}},[t._v('"schnorrkel/test-polyfill"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_verify_.html"}},[t._v('"schnorrkel/verify"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_secp256k1_recover_.html"}},[t._v('"secp256k1/recover"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_sha512_asu8a_.html"}},[t._v('"sha512/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html"}},[t._v('"types"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_ashex_.html"}},[t._v('"xxhash/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_asu8a_.html"}},[t._v('"xxhash/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asbn_.html"}},[t._v('"xxhash/xxhash64/asBn"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_ashex_.html"}},[t._v('"xxhash/xxhash64/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asraw_.html"}},[t._v('"xxhash/xxhash64/asRaw"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asvalue_.html"}},[t._v('"xxhash/xxhash64/asValue"')])],1)])])},[],!1,null,null,null);l.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[125],{424:function(t,l,r){"use strict";r.r(l);var o=r(37),e=Object(o.a)({},function(){var t=this,l=t.$createElement,r=t._self._c||l;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_ashex_.html"}},[t._v('"blake2/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_asu8a_.html"}},[t._v('"blake2/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_blake2b_ashex_.html"}},[t._v('"blake2/blake2b/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_blake2_blake2b_asu8a_.html"}},[t._v('"blake2/blake2b/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_keccak_ashex_.html"}},[t._v('"keccak/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_keccak_asu8a_.html"}},[t._v('"keccak/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_generate_.html"}},[t._v('"mnemonic/generate"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_tosecret_.html"}},[t._v('"mnemonic/toSecret"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_toseed_.html"}},[t._v('"mnemonic/toSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_mnemonic_validate_.html"}},[t._v('"mnemonic/validate"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_decrypt_.html"}},[t._v('"nacl/decrypt"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_encrypt_.html"}},[t._v('"nacl/encrypt"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromrandom_.html"}},[t._v('"nacl/keypair/fromRandom"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromsecret_.html"}},[t._v('"nacl/keypair/fromSecret"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromseed_.html"}},[t._v('"nacl/keypair/fromSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_keypair_fromstring_.html"}},[t._v('"nacl/keypair/fromString"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_sign_.html"}},[t._v('"nacl/sign"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_nacl_verify_.html"}},[t._v('"nacl/verify"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_ashex_.html"}},[t._v('"random/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_asnumber_.html"}},[t._v('"random/asNumber"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_random_asu8a_.html"}},[t._v('"random/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_keypair_fromseed_.html"}},[t._v('"schnorrkel/keypair/fromSeed"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_ready_.html"}},[t._v('"schnorrkel/ready"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_sign_.html"}},[t._v('"schnorrkel/sign"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_test_polyfill_.html"}},[t._v('"schnorrkel/test-polyfill"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_schnorrkel_verify_.html"}},[t._v('"schnorrkel/verify"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_secp256k1_recover_.html"}},[t._v('"secp256k1/recover"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_sha512_asu8a_.html"}},[t._v('"sha512/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_types_.html"}},[t._v('"types"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_ashex_.html"}},[t._v('"xxhash/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_asu8a_.html"}},[t._v('"xxhash/asU8a"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asbn_.html"}},[t._v('"xxhash/xxhash64/asBn"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_ashex_.html"}},[t._v('"xxhash/xxhash64/asHex"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asraw_.html"}},[t._v('"xxhash/xxhash64/asRaw"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/modules/_xxhash_xxhash64_asvalue_.html"}},[t._v('"xxhash/xxhash64/asValue"')])],1)])])},[],!1,null,null,null);l.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/126.d301e959.js b/docs/assets/js/126.d2ae721f.js similarity index 94% rename from docs/.vuepress/dist/assets/js/126.d301e959.js rename to docs/assets/js/126.d2ae721f.js index 8f4eb8849..7d883f226 100644 --- a/docs/.vuepress/dist/assets/js/126.d301e959.js +++ b/docs/assets/js/126.d2ae721f.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{426:function(t,e,a){"use strict";a.r(e);var s=a(37),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/6506c10/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.d0a7193e.js b/docs/assets/js/127.4ecdc6ea.js similarity index 95% rename from docs/.vuepress/dist/assets/js/127.d0a7193e.js rename to docs/assets/js/127.4ecdc6ea.js index 847430933..9a15cd9c2 100644 --- a/docs/.vuepress/dist/assets/js/127.d0a7193e.js +++ b/docs/assets/js/127.4ecdc6ea.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{423:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.f42a132c.js b/docs/assets/js/128.72db864b.js similarity index 94% rename from docs/.vuepress/dist/assets/js/128.f42a132c.js rename to docs/assets/js/128.72db864b.js index 284da385a..8fb345879 100644 --- a/docs/.vuepress/dist/assets/js/128.f42a132c.js +++ b/docs/assets/js/128.72db864b.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{421:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.4d3a6550.js b/docs/assets/js/129.2ff9d2ef.js similarity index 95% rename from docs/.vuepress/dist/assets/js/129.4d3a6550.js rename to docs/assets/js/129.2ff9d2ef.js index def990688..aec2b1bc4 100644 --- a/docs/.vuepress/dist/assets/js/129.4d3a6550.js +++ b/docs/assets/js/129.2ff9d2ef.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{420:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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/13.10b6985f.js b/docs/assets/js/13.b959cb4d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/13.10b6985f.js rename to docs/assets/js/13.b959cb4d.js index fd8c6572e..daec4a250 100644 --- a/docs/.vuepress/dist/assets/js/13.10b6985f.js +++ b/docs/assets/js/13.b959cb4d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{397:function(t,l,e){"use strict";e.r(l);var _=e(46),i=Object(_.a)({},function(){var t=this,l=t.$createElement,e=t._self._c||l;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/db/modules/_disk_.html"}},[t._v('"Disk"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_cache_.html"}},[t._v('"FileFlatDb/Cache"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_compact_.html"}},[t._v('"FileFlatDb/Compact"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_file_.html"}},[t._v('"FileFlatDb/File"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_impl_.html"}},[t._v('"FileFlatDb/Impl"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_serialize_.html"}},[t._v('"FileFlatDb/Serialize"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[t._v("Serialize")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_defaults_.html"}},[t._v('"FileFlatDb/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html"}},[t._v('"FileFlatDb/types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html"}},[t._v("Slot")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_memory_.html"}},[t._v('"Memory"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_filetreedb_.html"}},[t._v('"engines/FileTreeDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[t._v("FileTreeDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_lrudb_.html"}},[t._v('"engines/LruDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_memorydb_.html"}},[t._v('"engines/MemoryDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_transactiondb_.html"}},[t._v('"engines/TransactionDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)])],1)])])},[],!1,null,null,null);l.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{377:function(t,l,e){"use strict";e.r(l);var _=e(37),i=Object(_.a)({},function(){var t=this,l=t.$createElement,e=t._self._c||l;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/db/modules/_disk_.html"}},[t._v('"Disk"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_disk_.diskdb.html"}},[t._v("DiskDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_cache_.html"}},[t._v('"FileFlatDb/Cache"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_cache_.cache.html"}},[t._v("Cache")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_compact_.html"}},[t._v('"FileFlatDb/Compact"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_compact_.compact.html"}},[t._v("Compact")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_file_.html"}},[t._v('"FileFlatDb/File"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_impl_.html"}},[t._v('"FileFlatDb/Impl"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_impl_.impl.html"}},[t._v("Impl")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_serialize_.html"}},[t._v('"FileFlatDb/Serialize"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[t._v("Serialize")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_defaults_.html"}},[t._v('"FileFlatDb/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_fileflatdb_types_.html"}},[t._v('"FileFlatDb/types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/enums/_fileflatdb_types_.slot.html"}},[t._v("Slot")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_memory_.html"}},[t._v('"Memory"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_memory_.memory.html"}},[t._v("Memory")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_filetreedb_.html"}},[t._v('"engines/FileTreeDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[t._v("FileTreeDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_lrudb_.html"}},[t._v('"engines/LruDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_memorydb_.html"}},[t._v('"engines/MemoryDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_engines_transactiondb_.html"}},[t._v('"engines/TransactionDb"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/classes/_engines_transactiondb_.transactiondb.html"}},[t._v("TransactionDb")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/db/interfaces/_types_.basedb.html"}},[t._v("BaseDb")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/db/interfaces/_types_.txdb.html"}},[t._v("TxDb")])],1)])],1)])])},[],!1,null,null,null);l.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/130.d0dd4775.js b/docs/assets/js/130.d06f0c3c.js similarity index 94% rename from docs/.vuepress/dist/assets/js/130.d0dd4775.js rename to docs/assets/js/130.d06f0c3c.js index 9b9f6cbe2..79a3bb042 100644 --- a/docs/.vuepress/dist/assets/js/130.d0dd4775.js +++ b/docs/assets/js/130.d06f0c3c.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{418:function(t,e,a){"use strict";a.r(e);var s=a(37),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/6506c10/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.5391d115.js b/docs/assets/js/131.17484397.js similarity index 94% rename from docs/.vuepress/dist/assets/js/131.5391d115.js rename to docs/assets/js/131.17484397.js index 2a913c487..c3804f648 100644 --- a/docs/.vuepress/dist/assets/js/131.5391d115.js +++ b/docs/assets/js/131.17484397.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{417:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.3c1a5562.js b/docs/assets/js/132.e070cb90.js similarity index 94% rename from docs/.vuepress/dist/assets/js/132.3c1a5562.js rename to docs/assets/js/132.e070cb90.js index d61c87a68..0eb28df7c 100644 --- a/docs/.vuepress/dist/assets/js/132.3c1a5562.js +++ b/docs/assets/js/132.e070cb90.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{415:function(t,e,n){"use strict";n.r(e);var a=n(37),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/6506c10/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.4d7cdad5.js b/docs/assets/js/133.c0431e54.js similarity index 86% rename from docs/.vuepress/dist/assets/js/133.4d7cdad5.js rename to docs/assets/js/133.c0431e54.js index 83d2ba817..77786d8ae 100644 --- a/docs/.vuepress/dist/assets/js/133.4d7cdad5.js +++ b/docs/assets/js/133.c0431e54.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{414:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.175e14ba.js b/docs/assets/js/134.b22f5f0d.js similarity index 96% rename from docs/.vuepress/dist/assets/js/134.175e14ba.js rename to docs/assets/js/134.b22f5f0d.js index 69ff9f50f..a302dd488 100644 --- a/docs/.vuepress/dist/assets/js/134.175e14ba.js +++ b/docs/assets/js/134.b22f5f0d.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{412:function(t,n,s){"use strict";s.r(n);var a=s(37),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/6506c10/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.6c143002.js b/docs/assets/js/135.5cc41c51.js similarity index 95% rename from docs/.vuepress/dist/assets/js/135.6c143002.js rename to docs/assets/js/135.5cc41c51.js index 17c67af85..da9c6a1c1 100644 --- a/docs/.vuepress/dist/assets/js/135.6c143002.js +++ b/docs/assets/js/135.5cc41c51.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{411:function(t,n,a){"use strict";a.r(n);var e=a(37),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/6506c10/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.78afd8ff.js b/docs/assets/js/136.147023f3.js similarity index 95% rename from docs/.vuepress/dist/assets/js/136.78afd8ff.js rename to docs/assets/js/136.147023f3.js index 80e93c4b5..0f25ba725 100644 --- a/docs/.vuepress/dist/assets/js/136.78afd8ff.js +++ b/docs/assets/js/136.147023f3.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{409:function(t,a,n){"use strict";n.r(a);var e=n(37),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/6506c10/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.347ff027.js b/docs/assets/js/137.42931df5.js similarity index 95% rename from docs/.vuepress/dist/assets/js/137.347ff027.js rename to docs/assets/js/137.42931df5.js index 9b33aba3a..2a019db39 100644 --- a/docs/.vuepress/dist/assets/js/137.347ff027.js +++ b/docs/assets/js/137.42931df5.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{408:function(t,n,e){"use strict";e.r(n);var a=e(37),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/6506c10/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.df837b4b.js b/docs/assets/js/138.b4bbb4db.js similarity index 93% rename from docs/.vuepress/dist/assets/js/138.df837b4b.js rename to docs/assets/js/138.b4bbb4db.js index 448bf2cf7..4560a98fb 100644 --- a/docs/.vuepress/dist/assets/js/138.df837b4b.js +++ b/docs/assets/js/138.b4bbb4db.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{406:function(t,a,e){"use strict";e.r(a);var r=e(37),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/6506c10/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.65c63374.js b/docs/assets/js/139.82bc4ad3.js similarity index 94% rename from docs/.vuepress/dist/assets/js/139.65c63374.js rename to docs/assets/js/139.82bc4ad3.js index 047f790e4..51096abfc 100644 --- a/docs/.vuepress/dist/assets/js/139.65c63374.js +++ b/docs/assets/js/139.82bc4ad3.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{405:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.cdf62cb8.js b/docs/assets/js/14.032a2848.js similarity index 96% rename from docs/.vuepress/dist/assets/js/14.cdf62cb8.js rename to docs/assets/js/14.032a2848.js index 19e990be8..9bf608f8b 100644 --- a/docs/.vuepress/dist/assets/js/14.cdf62cb8.js +++ b/docs/assets/js/14.032a2848.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{398:function(t,s,n){"use strict";n.r(s);var a=n(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.51d65b0e.js b/docs/assets/js/140.fce8781e.js similarity index 94% rename from docs/.vuepress/dist/assets/js/140.51d65b0e.js rename to docs/assets/js/140.fce8781e.js index 049b5229b..f8a1b55f6 100644 --- a/docs/.vuepress/dist/assets/js/140.51d65b0e.js +++ b/docs/assets/js/140.fce8781e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{403:function(e,t,a){"use strict";a.r(t);var r=a(37),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/6506c10/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.f9a51cbf.js b/docs/assets/js/141.26601aba.js similarity index 92% rename from docs/.vuepress/dist/assets/js/141.f9a51cbf.js rename to docs/assets/js/141.26601aba.js index ce70a58c5..524593522 100644 --- a/docs/.vuepress/dist/assets/js/141.f9a51cbf.js +++ b/docs/assets/js/141.26601aba.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{402:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.6d88dd71.js b/docs/assets/js/142.e00f5606.js similarity index 93% rename from docs/.vuepress/dist/assets/js/142.6d88dd71.js rename to docs/assets/js/142.e00f5606.js index 362450681..d90e11cd8 100644 --- a/docs/.vuepress/dist/assets/js/142.6d88dd71.js +++ b/docs/assets/js/142.e00f5606.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{400:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.4026d731.js b/docs/assets/js/143.4111b1f3.js similarity index 95% rename from docs/.vuepress/dist/assets/js/143.4026d731.js rename to docs/assets/js/143.4111b1f3.js index 56cd47cd4..ddddda21f 100644 --- a/docs/.vuepress/dist/assets/js/143.4026d731.js +++ b/docs/assets/js/143.4111b1f3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{399:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.22f9176e.js b/docs/assets/js/144.0776e2dd.js similarity index 93% rename from docs/.vuepress/dist/assets/js/144.22f9176e.js rename to docs/assets/js/144.0776e2dd.js index fd3fb8964..b9674cf75 100644 --- a/docs/.vuepress/dist/assets/js/144.22f9176e.js +++ b/docs/assets/js/144.0776e2dd.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{397:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.5b4bc4d5.js b/docs/assets/js/145.1adb9530.js similarity index 93% rename from docs/.vuepress/dist/assets/js/145.5b4bc4d5.js rename to docs/assets/js/145.1adb9530.js index 41f5a9e44..003e4bd0b 100644 --- a/docs/.vuepress/dist/assets/js/145.5b4bc4d5.js +++ b/docs/assets/js/145.1adb9530.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{396:function(t,s,a){"use strict";a.r(s);var r=a(37),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/6506c10/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.af7eed4e.js b/docs/assets/js/146.412d78c3.js similarity index 94% rename from docs/.vuepress/dist/assets/js/146.af7eed4e.js rename to docs/assets/js/146.412d78c3.js index 662a9d4d8..94e4d3376 100644 --- a/docs/.vuepress/dist/assets/js/146.af7eed4e.js +++ b/docs/assets/js/146.412d78c3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{394:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.ee00a155.js b/docs/assets/js/147.c8a9528f.js similarity index 90% rename from docs/.vuepress/dist/assets/js/147.ee00a155.js rename to docs/assets/js/147.c8a9528f.js index aff06259c..eb68c5fe9 100644 --- a/docs/.vuepress/dist/assets/js/147.ee00a155.js +++ b/docs/assets/js/147.c8a9528f.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{393:function(e,r,t){"use strict";t.r(r);var o=t(37),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/6506c10/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.9f987a2b.js b/docs/assets/js/148.202f77ec.js similarity index 84% rename from docs/.vuepress/dist/assets/js/148.9f987a2b.js rename to docs/assets/js/148.202f77ec.js index 25cdef7e3..3b6bd495a 100644 --- a/docs/.vuepress/dist/assets/js/148.9f987a2b.js +++ b/docs/assets/js/148.202f77ec.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{391:function(r,e,t){"use strict";t.r(e);var a=t(37),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/6506c10/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/6506c10/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.cad6b842.js b/docs/assets/js/149.70229024.js similarity index 89% rename from docs/.vuepress/dist/assets/js/149.cad6b842.js rename to docs/assets/js/149.70229024.js index 4e5da1ac7..9e7d65cff 100644 --- a/docs/.vuepress/dist/assets/js/149.cad6b842.js +++ b/docs/assets/js/149.70229024.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{390:function(e,t,r){"use strict";r.r(t);var s=r(37),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/6506c10/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.06d67387.js b/docs/assets/js/15.7c452aa6.js similarity index 93% rename from docs/.vuepress/dist/assets/js/15.06d67387.js rename to docs/assets/js/15.7c452aa6.js index cf45926ce..fdfd8340d 100644 --- a/docs/.vuepress/dist/assets/js/15.06d67387.js +++ b/docs/assets/js/15.7c452aa6.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{380:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/150.4fd1ea3a.js b/docs/assets/js/150.8d98203f.js similarity index 58% rename from docs/.vuepress/dist/assets/js/150.4fd1ea3a.js rename to docs/assets/js/150.8d98203f.js index 7965454be..4702d410a 100644 --- a/docs/.vuepress/dist/assets/js/150.4fd1ea3a.js +++ b/docs/assets/js/150.8d98203f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[150],{407: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([[150],{387:function(t,e,n){"use strict";n.r(e);var s=n(37),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/151.07167f62.js b/docs/assets/js/151.af5bc0f5.js similarity index 90% rename from docs/.vuepress/dist/assets/js/151.07167f62.js rename to docs/assets/js/151.af5bc0f5.js index bd4c68015..850aeb7e3 100644 --- a/docs/.vuepress/dist/assets/js/151.07167f62.js +++ b/docs/assets/js/151.af5bc0f5.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[151],{388:function(e,r,t){"use strict";t.r(r);var n=t(37),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/6506c10/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.45295d3e.js b/docs/assets/js/152.42cdb5b3.js similarity index 90% rename from docs/.vuepress/dist/assets/js/152.45295d3e.js rename to docs/assets/js/152.42cdb5b3.js index 578863a0b..789dbc711 100644 --- a/docs/.vuepress/dist/assets/js/152.45295d3e.js +++ b/docs/assets/js/152.42cdb5b3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{385:function(e,r,t){"use strict";t.r(r);var v=t(37),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/6506c10/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.b09d25ec.js b/docs/assets/js/153.5c27674b.js similarity index 94% rename from docs/.vuepress/dist/assets/js/153.b09d25ec.js rename to docs/assets/js/153.5c27674b.js index 93ef45026..2c7dc0ba6 100644 --- a/docs/.vuepress/dist/assets/js/153.b09d25ec.js +++ b/docs/assets/js/153.5c27674b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{384:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.dcf40e55.js b/docs/assets/js/154.847afe83.js similarity index 84% rename from docs/.vuepress/dist/assets/js/154.dcf40e55.js rename to docs/assets/js/154.847afe83.js index 5e61f3e09..97769da10 100644 --- a/docs/.vuepress/dist/assets/js/154.dcf40e55.js +++ b/docs/assets/js/154.847afe83.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[154],{382:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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.e8630fed.js b/docs/assets/js/155.6068a0ba.js similarity index 94% rename from docs/.vuepress/dist/assets/js/155.e8630fed.js rename to docs/assets/js/155.6068a0ba.js index 8d7e79e41..05c534d3c 100644 --- a/docs/.vuepress/dist/assets/js/155.e8630fed.js +++ b/docs/assets/js/155.6068a0ba.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[155],{381:function(t,e,s){"use strict";s.r(e);var a=s(37),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/6506c10/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.cd310ab3.js b/docs/assets/js/156.cca2e4ce.js similarity index 94% rename from docs/.vuepress/dist/assets/js/156.cd310ab3.js rename to docs/assets/js/156.cca2e4ce.js index 2293f9ca9..50ab4041c 100644 --- a/docs/.vuepress/dist/assets/js/156.cd310ab3.js +++ b/docs/assets/js/156.cca2e4ce.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{379:function(t,a,s){"use strict";s.r(a);var e=s(37),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/6506c10/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.fbb601cd.js b/docs/assets/js/157.8a106491.js similarity index 94% rename from docs/.vuepress/dist/assets/js/157.fbb601cd.js rename to docs/assets/js/157.8a106491.js index 581e9681c..103f7935c 100644 --- a/docs/.vuepress/dist/assets/js/157.fbb601cd.js +++ b/docs/assets/js/157.8a106491.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{378:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.2d59a307.js b/docs/assets/js/158.b46ff7ee.js similarity index 94% rename from docs/.vuepress/dist/assets/js/158.2d59a307.js rename to docs/assets/js/158.b46ff7ee.js index c94cb8609..715c42159 100644 --- a/docs/.vuepress/dist/assets/js/158.2d59a307.js +++ b/docs/assets/js/158.b46ff7ee.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{376:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.c5393dcf.js b/docs/assets/js/159.8fd507c3.js similarity index 94% rename from docs/.vuepress/dist/assets/js/159.c5393dcf.js rename to docs/assets/js/159.8fd507c3.js index a0ec2c52f..ce1fa390c 100644 --- a/docs/.vuepress/dist/assets/js/159.c5393dcf.js +++ b/docs/assets/js/159.8fd507c3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{375:function(t,a,s){"use strict";s.r(a);var e=s(37),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/6506c10/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.f65ce986.js b/docs/assets/js/16.6dcc64ce.js similarity index 93% rename from docs/.vuepress/dist/assets/js/16.f65ce986.js rename to docs/assets/js/16.6dcc64ce.js index ce3534f83..f79b3ea30 100644 --- a/docs/.vuepress/dist/assets/js/16.f65ce986.js +++ b/docs/assets/js/16.6dcc64ce.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{383:function(t,e,r){"use strict";r.r(e);var _=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.9d78b704.js b/docs/assets/js/160.833cdd45.js similarity index 94% rename from docs/.vuepress/dist/assets/js/160.9d78b704.js rename to docs/assets/js/160.833cdd45.js index e3a0119f6..fbbc27178 100644 --- a/docs/.vuepress/dist/assets/js/160.9d78b704.js +++ b/docs/assets/js/160.833cdd45.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{373:function(t,a,s){"use strict";s.r(a);var e=s(37),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/6506c10/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.7cf36eee.js b/docs/assets/js/161.3496fa41.js similarity index 95% rename from docs/.vuepress/dist/assets/js/161.7cf36eee.js rename to docs/assets/js/161.3496fa41.js index eafe3eb0b..d0c5f4639 100644 --- a/docs/.vuepress/dist/assets/js/161.7cf36eee.js +++ b/docs/assets/js/161.3496fa41.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[161],{372:function(t,e,a){"use strict";a.r(e);var s=a(37),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.44f64348.js b/docs/assets/js/162.48b0fdbe.js similarity index 93% rename from docs/.vuepress/dist/assets/js/162.44f64348.js rename to docs/assets/js/162.48b0fdbe.js index 5802398af..e2b8662d1 100644 --- a/docs/.vuepress/dist/assets/js/162.44f64348.js +++ b/docs/assets/js/162.48b0fdbe.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{370:function(t,e,l){"use strict";l.r(e);var r=l(37),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.6d8d5318.js b/docs/assets/js/163.9ef27d9f.js similarity index 58% rename from docs/.vuepress/dist/assets/js/163.6d8d5318.js rename to docs/assets/js/163.9ef27d9f.js index a89ccbdac..48f8753ad 100644 --- a/docs/.vuepress/dist/assets/js/163.6d8d5318.js +++ b/docs/assets/js/163.9ef27d9f.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{369:function(t,e,n){"use strict";n.r(e);var s=n(37),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.5c07ac11.js b/docs/assets/js/164.0f2d3118.js similarity index 84% rename from docs/.vuepress/dist/assets/js/164.5c07ac11.js rename to docs/assets/js/164.0f2d3118.js index ebb715862..c3b10aa57 100644 --- a/docs/.vuepress/dist/assets/js/164.5c07ac11.js +++ b/docs/assets/js/164.0f2d3118.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{367:function(t,e,r){"use strict";r.r(e);var o=r(37),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/6506c10/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.3ea85802.js b/docs/assets/js/165.a160873b.js similarity index 90% rename from docs/.vuepress/dist/assets/js/165.3ea85802.js rename to docs/assets/js/165.a160873b.js index 052b4ad32..aa249044a 100644 --- a/docs/.vuepress/dist/assets/js/165.3ea85802.js +++ b/docs/assets/js/165.a160873b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{366:function(t,e,o){"use strict";o.r(e);var r=o(37),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/6506c10/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.e8c681e5.js b/docs/assets/js/166.501ce12d.js similarity index 90% rename from docs/.vuepress/dist/assets/js/166.e8c681e5.js rename to docs/assets/js/166.501ce12d.js index b6003672c..eefafc3fc 100644 --- a/docs/.vuepress/dist/assets/js/166.e8c681e5.js +++ b/docs/assets/js/166.501ce12d.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{364:function(t,e,r){"use strict";r.r(e);var o=r(37),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/6506c10/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.ba95f807.js b/docs/assets/js/167.99fa3025.js similarity index 90% rename from docs/.vuepress/dist/assets/js/167.ba95f807.js rename to docs/assets/js/167.99fa3025.js index d03415bff..45e46f891 100644 --- a/docs/.vuepress/dist/assets/js/167.ba95f807.js +++ b/docs/assets/js/167.99fa3025.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{361:function(e,t,r){"use strict";r.r(t);var o=r(37),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/6506c10/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.99af1574.js b/docs/assets/js/168.7ccc4634.js similarity index 87% rename from docs/.vuepress/dist/assets/js/168.99af1574.js rename to docs/assets/js/168.7ccc4634.js index 86652d0f5..71536b3b9 100644 --- a/docs/.vuepress/dist/assets/js/168.99af1574.js +++ b/docs/assets/js/168.7ccc4634.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{363:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.3a3e8489.js b/docs/assets/js/169.08d2427a.js similarity index 90% rename from docs/.vuepress/dist/assets/js/169.3a3e8489.js rename to docs/assets/js/169.08d2427a.js index 85ee72f5c..44c6507b7 100644 --- a/docs/.vuepress/dist/assets/js/169.3a3e8489.js +++ b/docs/assets/js/169.08d2427a.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{360:function(e,t,r){"use strict";r.r(t);var o=r(37),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/6506c10/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.66687909.js b/docs/assets/js/17.b17bf66a.js similarity index 93% rename from docs/.vuepress/dist/assets/js/17.66687909.js rename to docs/assets/js/17.b17bf66a.js index e0afa7118..281361626 100644 --- a/docs/.vuepress/dist/assets/js/17.66687909.js +++ b/docs/assets/js/17.b17bf66a.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{386:function(t,e,r){"use strict";r.r(e);var s=r(37),_=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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.50e773a0.js b/docs/assets/js/170.714e81b8.js similarity index 90% rename from docs/.vuepress/dist/assets/js/170.50e773a0.js rename to docs/assets/js/170.714e81b8.js index 16a36034f..cdb4aaa52 100644 --- a/docs/.vuepress/dist/assets/js/170.50e773a0.js +++ b/docs/assets/js/170.714e81b8.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{358:function(t,e,r){"use strict";r.r(e);var o=r(37),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/6506c10/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.2c1f7987.js b/docs/assets/js/171.e44a8ab9.js similarity index 90% rename from docs/.vuepress/dist/assets/js/171.2c1f7987.js rename to docs/assets/js/171.e44a8ab9.js index 0a2d40a21..dc0617a72 100644 --- a/docs/.vuepress/dist/assets/js/171.2c1f7987.js +++ b/docs/assets/js/171.e44a8ab9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{357:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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.d1afffc0.js b/docs/assets/js/172.d1afffc0.js new file mode 100644 index 000000000..12d5e58c1 --- /dev/null +++ b/docs/assets/js/172.d1afffc0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{355:function(t,e,n){"use strict";n.r(e);var s=n(37),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.fa8116ca.js b/docs/assets/js/173.b48b8ada.js similarity index 89% rename from docs/.vuepress/dist/assets/js/173.fa8116ca.js rename to docs/assets/js/173.b48b8ada.js index 73273040e..91e15306f 100644 --- a/docs/.vuepress/dist/assets/js/173.fa8116ca.js +++ b/docs/assets/js/173.b48b8ada.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[173],{354:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.cd35051f.js b/docs/assets/js/174.425af5aa.js similarity index 88% rename from docs/.vuepress/dist/assets/js/174.cd35051f.js rename to docs/assets/js/174.425af5aa.js index cc4b83731..63846431b 100644 --- a/docs/.vuepress/dist/assets/js/174.cd35051f.js +++ b/docs/assets/js/174.425af5aa.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{352:function(e,t,n){"use strict";n.r(t);var r=n(37),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/6506c10/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.d225e122.js b/docs/assets/js/175.a572380f.js similarity index 86% rename from docs/.vuepress/dist/assets/js/175.d225e122.js rename to docs/assets/js/175.a572380f.js index 698fa8dea..cc5ab0431 100644 --- a/docs/.vuepress/dist/assets/js/175.d225e122.js +++ b/docs/assets/js/175.a572380f.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[175],{351:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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.037c9c6a.js b/docs/assets/js/176.14ee536c.js similarity index 88% rename from docs/.vuepress/dist/assets/js/176.037c9c6a.js rename to docs/assets/js/176.14ee536c.js index f677be6b8..0319affdb 100644 --- a/docs/.vuepress/dist/assets/js/176.037c9c6a.js +++ b/docs/assets/js/176.14ee536c.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{350:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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.25bdd03b.js b/docs/assets/js/177.52052555.js similarity index 89% rename from docs/.vuepress/dist/assets/js/177.25bdd03b.js rename to docs/assets/js/177.52052555.js index f7f946a43..31c3b2086 100644 --- a/docs/.vuepress/dist/assets/js/177.25bdd03b.js +++ b/docs/assets/js/177.52052555.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{349:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.15534701.js b/docs/assets/js/178.6fc260b1.js similarity index 94% rename from docs/.vuepress/dist/assets/js/178.15534701.js rename to docs/assets/js/178.6fc260b1.js index 2533645b6..07552a2a0 100644 --- a/docs/.vuepress/dist/assets/js/178.15534701.js +++ b/docs/assets/js/178.6fc260b1.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{348:function(t,a,s){"use strict";s.r(a);var e=s(37),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/179.66fbf342.js b/docs/assets/js/179.db22179f.js similarity index 98% rename from docs/.vuepress/dist/assets/js/179.66fbf342.js rename to docs/assets/js/179.db22179f.js index 10f1995fd..86956d322 100644 --- a/docs/.vuepress/dist/assets/js/179.66fbf342.js +++ b/docs/assets/js/179.db22179f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[179],{367:function(t,l,_){"use strict";_.r(l);var r=_(46),o=Object(r.a)({},function(){var t=this,l=t.$createElement,_=t._self._c||l;return _("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[_("ul",[_("li",[_("router-link",{attrs:{to:"/util/modules/_array_filter_.html"}},[t._v('"array/filter"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_assert_.html"}},[t._v('"assert"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_fromhex_.html"}},[t._v('"bn/fromHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tobn_.html"}},[t._v('"bn/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tohex_.html"}},[t._v('"bn/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tou8a_.html"}},[t._v('"bn/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_buffer_tou8a_.html"}},[t._v('"buffer/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_addlength_.html"}},[t._v('"compact/addLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_defaults_.html"}},[t._v('"compact/defaults"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_fromu8a_.html"}},[t._v('"compact/fromU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_striplength_.html"}},[t._v('"compact/stripLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_tou8a_.html"}},[t._v('"compact/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_types_.html"}},[t._v('"compact/types"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_ext_error_.html"}},[t._v('"ext/error"')]),t._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_addprefix_.html"}},[t._v('"hex/addPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_fixlength_.html"}},[t._v('"hex/fixLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_hasprefix_.html"}},[t._v('"hex/hasPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_stripprefix_.html"}},[t._v('"hex/stripPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tobn_.html"}},[t._v('"hex/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tonumber_.html"}},[t._v('"hex/toNumber"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tou8a_.html"}},[t._v('"hex/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_bn_.html"}},[t._v('"is/bn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_boolean_.html"}},[t._v('"is/boolean"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_buffer_.html"}},[t._v('"is/buffer"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_error_.html"}},[t._v('"is/error"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_function_.html"}},[t._v('"is/function"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_hex_.html"}},[t._v('"is/hex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_instanceof_.html"}},[t._v('"is/instanceOf"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_ip_.html"}},[t._v('"is/ip"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_null_.html"}},[t._v('"is/null"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_number_.html"}},[t._v('"is/number"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_object_.html"}},[t._v('"is/object"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_observable_.html"}},[t._v('"is/observable"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_string_.html"}},[t._v('"is/string"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_u8a_.html"}},[t._v('"is/u8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_undefined_.html"}},[t._v('"is/undefined"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_logger_.html"}},[t._v('"logger"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_number_tohex_.html"}},[t._v('"number/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_number_tou8a_.html"}},[t._v('"number/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_fill_.html"}},[t._v('"polyfill/fill"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_padend_.html"}},[t._v('"polyfill/padEnd"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_padstart_.html"}},[t._v('"polyfill/padStart"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_setprototypeof_.html"}},[t._v('"polyfill/setPrototypeOf"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_textdecoder_.html"}},[t._v('"polyfill/textDecoder"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_textencoder_.html"}},[t._v('"polyfill/textEncoder"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_promisify_.html"}},[t._v('"promisify"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_camelcase_.html"}},[t._v('"string/camelCase"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_lowerfirst_.html"}},[t._v('"string/lowerFirst"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_shorten_.html"}},[t._v('"string/shorten"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_tou8a_.html"}},[t._v('"string/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_upperfirst_.html"}},[t._v('"string/upperFirst"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_syncify_.html"}},[t._v('"syncify"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")])],1)])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_concat_.html"}},[t._v('"u8a/concat"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_fixlength_.html"}},[t._v('"u8a/fixLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tobn_.html"}},[t._v('"u8a/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tobuffer_.html"}},[t._v('"u8a/toBuffer"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tohex_.html"}},[t._v('"u8a/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tostring_.html"}},[t._v('"u8a/toString"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tou8a_.html"}},[t._v('"u8a/toU8a"')])],1)])])},[],!1,null,null,null);l.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[179],{347:function(t,l,_){"use strict";_.r(l);var r=_(37),o=Object(r.a)({},function(){var t=this,l=t.$createElement,_=t._self._c||l;return _("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[_("ul",[_("li",[_("router-link",{attrs:{to:"/util/modules/_array_filter_.html"}},[t._v('"array/filter"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_assert_.html"}},[t._v('"assert"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_fromhex_.html"}},[t._v('"bn/fromHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tobn_.html"}},[t._v('"bn/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tohex_.html"}},[t._v('"bn/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_bn_tou8a_.html"}},[t._v('"bn/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_buffer_tou8a_.html"}},[t._v('"buffer/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_addlength_.html"}},[t._v('"compact/addLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_defaults_.html"}},[t._v('"compact/defaults"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_fromu8a_.html"}},[t._v('"compact/fromU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_striplength_.html"}},[t._v('"compact/stripLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_tou8a_.html"}},[t._v('"compact/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_compact_types_.html"}},[t._v('"compact/types"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_ext_error_.html"}},[t._v('"ext/error"')]),t._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/util/classes/_ext_error_.exterror.html"}},[t._v("ExtError")])],1)])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_addprefix_.html"}},[t._v('"hex/addPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_fixlength_.html"}},[t._v('"hex/fixLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_hasprefix_.html"}},[t._v('"hex/hasPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_stripprefix_.html"}},[t._v('"hex/stripPrefix"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tobn_.html"}},[t._v('"hex/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tonumber_.html"}},[t._v('"hex/toNumber"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_hex_tou8a_.html"}},[t._v('"hex/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_bn_.html"}},[t._v('"is/bn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_boolean_.html"}},[t._v('"is/boolean"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_buffer_.html"}},[t._v('"is/buffer"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_error_.html"}},[t._v('"is/error"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_function_.html"}},[t._v('"is/function"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_hex_.html"}},[t._v('"is/hex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_instanceof_.html"}},[t._v('"is/instanceOf"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_ip_.html"}},[t._v('"is/ip"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_null_.html"}},[t._v('"is/null"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_number_.html"}},[t._v('"is/number"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_object_.html"}},[t._v('"is/object"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_observable_.html"}},[t._v('"is/observable"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_string_.html"}},[t._v('"is/string"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_u8a_.html"}},[t._v('"is/u8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_is_undefined_.html"}},[t._v('"is/undefined"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_logger_.html"}},[t._v('"logger"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_number_tohex_.html"}},[t._v('"number/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_number_tou8a_.html"}},[t._v('"number/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_fill_.html"}},[t._v('"polyfill/fill"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_padend_.html"}},[t._v('"polyfill/padEnd"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_padstart_.html"}},[t._v('"polyfill/padStart"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_setprototypeof_.html"}},[t._v('"polyfill/setPrototypeOf"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_textdecoder_.html"}},[t._v('"polyfill/textDecoder"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_polyfill_textencoder_.html"}},[t._v('"polyfill/textEncoder"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_promisify_.html"}},[t._v('"promisify"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_camelcase_.html"}},[t._v('"string/camelCase"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_lowerfirst_.html"}},[t._v('"string/lowerFirst"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_shorten_.html"}},[t._v('"string/shorten"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_tou8a_.html"}},[t._v('"string/toU8a"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_string_upperfirst_.html"}},[t._v('"string/upperFirst"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_syncify_.html"}},[t._v('"syncify"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/util/interfaces/_types_.exterrorinterface.html"}},[t._v("ExtErrorInterface")])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/interfaces/_types_.tobnoptions.html"}},[t._v("ToBnOptions")])],1)])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_concat_.html"}},[t._v('"u8a/concat"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_fixlength_.html"}},[t._v('"u8a/fixLength"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tobn_.html"}},[t._v('"u8a/toBn"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tobuffer_.html"}},[t._v('"u8a/toBuffer"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tohex_.html"}},[t._v('"u8a/toHex"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tostring_.html"}},[t._v('"u8a/toString"')])],1),t._v(" "),_("li",[_("router-link",{attrs:{to:"/util/modules/_u8a_tou8a_.html"}},[t._v('"u8a/toU8a"')])],1)])])},[],!1,null,null,null);l.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/18.d8e7daec.js b/docs/assets/js/18.829e720b.js similarity index 93% rename from docs/.vuepress/dist/assets/js/18.d8e7daec.js rename to docs/assets/js/18.829e720b.js index 94ec34fb7..d322d66b9 100644 --- a/docs/.vuepress/dist/assets/js/18.d8e7daec.js +++ b/docs/assets/js/18.829e720b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{389:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.d0d7416a.js b/docs/assets/js/180.4c6a886c.js similarity index 91% rename from docs/.vuepress/dist/assets/js/180.d0d7416a.js rename to docs/assets/js/180.4c6a886c.js index 147522875..ec212cd53 100644 --- a/docs/.vuepress/dist/assets/js/180.d0d7416a.js +++ b/docs/assets/js/180.4c6a886c.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{345:function(t,r,e){"use strict";e.r(r);var a=e(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.265ffcde.js b/docs/assets/js/181.004b402b.js similarity index 85% rename from docs/.vuepress/dist/assets/js/181.265ffcde.js rename to docs/assets/js/181.004b402b.js index 989826c8b..9fccbbbaa 100644 --- a/docs/.vuepress/dist/assets/js/181.265ffcde.js +++ b/docs/assets/js/181.004b402b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{346:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.17aac8ce.js b/docs/assets/js/182.f0add510.js similarity index 87% rename from docs/.vuepress/dist/assets/js/182.17aac8ce.js rename to docs/assets/js/182.f0add510.js index 310e75a59..1b465be44 100644 --- a/docs/.vuepress/dist/assets/js/182.17aac8ce.js +++ b/docs/assets/js/182.f0add510.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{344:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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/6506c10/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.497b2283.js b/docs/assets/js/183.100a2714.js similarity index 96% rename from docs/.vuepress/dist/assets/js/183.497b2283.js rename to docs/assets/js/183.100a2714.js index 6ded1af4e..fbc962231 100644 --- a/docs/.vuepress/dist/assets/js/183.497b2283.js +++ b/docs/assets/js/183.100a2714.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{343:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.478a891c.js b/docs/assets/js/184.4ad7001e.js similarity index 96% rename from docs/.vuepress/dist/assets/js/184.478a891c.js rename to docs/assets/js/184.4ad7001e.js index d2305e94c..2ab483c17 100644 --- a/docs/.vuepress/dist/assets/js/184.478a891c.js +++ b/docs/assets/js/184.4ad7001e.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{342:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.8da9afcf.js b/docs/assets/js/185.8da9afcf.js new file mode 100644 index 000000000..5ffa85830 --- /dev/null +++ b/docs/assets/js/185.8da9afcf.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{341:function(t,e,n){"use strict";n.r(e);var s=n(37),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.77a23514.js b/docs/assets/js/186.8172d2cf.js similarity index 95% rename from docs/.vuepress/dist/assets/js/186.77a23514.js rename to docs/assets/js/186.8172d2cf.js index 8732b0e0f..c096cb1f9 100644 --- a/docs/.vuepress/dist/assets/js/186.77a23514.js +++ b/docs/assets/js/186.8172d2cf.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{340:function(t,n,s){"use strict";s.r(n);var a=s(37),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/6506c10/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.765f81a4.js b/docs/assets/js/187.23acc0a4.js similarity index 95% rename from docs/.vuepress/dist/assets/js/187.765f81a4.js rename to docs/assets/js/187.23acc0a4.js index 741a35169..8132e0d1a 100644 --- a/docs/.vuepress/dist/assets/js/187.765f81a4.js +++ b/docs/assets/js/187.23acc0a4.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{339:function(t,e,s){"use strict";s.r(e);var n=s(37),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/6506c10/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.348a5174.js b/docs/assets/js/188.376b50e9.js similarity index 95% rename from docs/.vuepress/dist/assets/js/188.348a5174.js rename to docs/assets/js/188.376b50e9.js index a426492b3..d7b1e4f7f 100644 --- a/docs/.vuepress/dist/assets/js/188.348a5174.js +++ b/docs/assets/js/188.376b50e9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{338:function(t,e,n){"use strict";n.r(e);var a=n(37),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/6506c10/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/6506c10/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.68693ae1.js b/docs/assets/js/189.6c0c60ae.js similarity index 95% rename from docs/.vuepress/dist/assets/js/189.68693ae1.js rename to docs/assets/js/189.6c0c60ae.js index accf946f8..3819a41e7 100644 --- a/docs/.vuepress/dist/assets/js/189.68693ae1.js +++ b/docs/assets/js/189.6c0c60ae.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{337:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.abe0aba9.js b/docs/assets/js/19.97179220.js similarity index 90% rename from docs/.vuepress/dist/assets/js/19.abe0aba9.js rename to docs/assets/js/19.97179220.js index 20584c9f2..6e1d6106d 100644 --- a/docs/.vuepress/dist/assets/js/19.abe0aba9.js +++ b/docs/assets/js/19.97179220.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{392:function(t,e,r){"use strict";r.r(e);var s=r(37),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/6506c10/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.5992cf8d.js b/docs/assets/js/190.e187a839.js similarity index 95% rename from docs/.vuepress/dist/assets/js/190.5992cf8d.js rename to docs/assets/js/190.e187a839.js index 459131c5e..7a543655a 100644 --- a/docs/.vuepress/dist/assets/js/190.5992cf8d.js +++ b/docs/assets/js/190.e187a839.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{336:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.9561b139.js b/docs/assets/js/191.2ffa7e1c.js similarity index 84% rename from docs/.vuepress/dist/assets/js/191.9561b139.js rename to docs/assets/js/191.2ffa7e1c.js index 0859fd2fc..846014d46 100644 --- a/docs/.vuepress/dist/assets/js/191.9561b139.js +++ b/docs/assets/js/191.2ffa7e1c.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{335:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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.f7cb00e8.js b/docs/assets/js/192.90321ed4.js similarity index 96% rename from docs/.vuepress/dist/assets/js/192.f7cb00e8.js rename to docs/assets/js/192.90321ed4.js index f0dc95733..3d631c389 100644 --- a/docs/.vuepress/dist/assets/js/192.f7cb00e8.js +++ b/docs/assets/js/192.90321ed4.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[192],{334:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.ec9dac13.js b/docs/assets/js/193.1d8da650.js similarity index 96% rename from docs/.vuepress/dist/assets/js/193.ec9dac13.js rename to docs/assets/js/193.1d8da650.js index fd366f31f..b3b1d5ef4 100644 --- a/docs/.vuepress/dist/assets/js/193.ec9dac13.js +++ b/docs/assets/js/193.1d8da650.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{333:function(t,a,n){"use strict";n.r(a);var s=n(37),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/6506c10/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.91654e88.js b/docs/assets/js/194.584a43fe.js similarity index 94% rename from docs/.vuepress/dist/assets/js/194.91654e88.js rename to docs/assets/js/194.584a43fe.js index e13fff50f..63ca69825 100644 --- a/docs/.vuepress/dist/assets/js/194.91654e88.js +++ b/docs/assets/js/194.584a43fe.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{332:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.1089c5be.js b/docs/assets/js/195.43ee6df7.js similarity index 84% rename from docs/.vuepress/dist/assets/js/195.1089c5be.js rename to docs/assets/js/195.43ee6df7.js index 3c2b5950e..fbb8d2eb4 100644 --- a/docs/.vuepress/dist/assets/js/195.1089c5be.js +++ b/docs/assets/js/195.43ee6df7.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[195],{331:function(t,e,a){"use strict";a.r(e);var s=a(37),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/6506c10/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.46524ef0.js b/docs/assets/js/196.6ecdd8d6.js similarity index 82% rename from docs/.vuepress/dist/assets/js/196.46524ef0.js rename to docs/assets/js/196.6ecdd8d6.js index 87ef870f3..c9ab9fc93 100644 --- a/docs/.vuepress/dist/assets/js/196.46524ef0.js +++ b/docs/assets/js/196.6ecdd8d6.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{330:function(t,r,e){"use strict";e.r(r);var s=e(37),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.72ae4804.js b/docs/assets/js/197.2f6af89c.js similarity index 94% rename from docs/.vuepress/dist/assets/js/197.72ae4804.js rename to docs/assets/js/197.2f6af89c.js index 6c05b0d92..b4c808046 100644 --- a/docs/.vuepress/dist/assets/js/197.72ae4804.js +++ b/docs/assets/js/197.2f6af89c.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{329:function(t,e,s){"use strict";s.r(e);var a=s(37),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/6506c10/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.67fc5eb5.js b/docs/assets/js/198.5ed8a911.js similarity index 97% rename from docs/.vuepress/dist/assets/js/198.67fc5eb5.js rename to docs/assets/js/198.5ed8a911.js index 2b05c3535..6921635ba 100644 --- a/docs/.vuepress/dist/assets/js/198.67fc5eb5.js +++ b/docs/assets/js/198.5ed8a911.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[198],{328:function(t,s,n){"use strict";n.r(s);var e=n(37),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/6506c10/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.24cd895b.js b/docs/assets/js/199.bfe990cb.js similarity index 94% rename from docs/.vuepress/dist/assets/js/199.24cd895b.js rename to docs/assets/js/199.bfe990cb.js index c3a85ab30..f30bd2356 100644 --- a/docs/.vuepress/dist/assets/js/199.24cd895b.js +++ b/docs/assets/js/199.bfe990cb.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{327:function(t,s,e){"use strict";e.r(s);var a=e(37),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/6506c10/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/2.d4a769c9.js b/docs/assets/js/2.d4a769c9.js new file mode 100644 index 000000000..4d8067ef2 --- /dev/null +++ b/docs/assets/js/2.d4a769c9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[2],{226:function(t,e,n){"use strict";n.d(e,"d",function(){return i}),n.d(e,"a",function(){return r}),n.d(e,"j",function(){return a}),n.d(e,"i",function(){return o}),n.d(e,"f",function(){return u}),n.d(e,"g",function(){return c}),n.d(e,"h",function(){return l}),n.d(e,"b",function(){return h}),n.d(e,"e",function(){return p}),n.d(e,"l",function(){return f}),n.d(e,"m",function(){return d}),n.d(e,"c",function(){return g}),n.d(e,"k",function(){return v});const i=/#.*$/,s=/\.(md|html)$/,r=/\/$/,a=/^(https?:|mailto:|tel:)/;function o(t){return decodeURI(t).replace(i,"").replace(s,"")}function u(t){return a.test(t)}function c(t){return/^mailto:/.test(t)}function l(t){return/^tel:/.test(t)}function h(t){if(u(t))return t;const e=t.match(i),n=e?e[0]:"",s=o(t);return r.test(s)?t:s+".html"+n}function p(t,e){const n=t.hash,s=function(t){const e=t.match(i);if(e)return e[0]}(e);return(!s||n===s)&&o(t.path)===o(e)}function f(t,e,n){n&&(e=function(t,e,n){const i=t.charAt(0);if("/"===i)return t;if("?"===i||"#"===i)return e+t;const s=e.split("/");n&&s[s.length-1]||s.pop();const r=t.replace(/^\//,"").split("/");for(let t=0;t({type:"auto",title:e.title,basePath:t.path,path:t.path+"#"+e.slug,children:e.children||[]}))}]}(t);const o=a.sidebar||r.sidebar;if(o){const{base:t,config:n}=function(t,e){if(Array.isArray(e))return{base:"/",config:e};for(const i in e)if(0===(n=t,/(\.html|\/)$/.test(n)?n:n+"/").indexOf(i))return{base:i,config:e[i]};var n;return{}}(e,o);return n?n.map(e=>(function t(e,n,i,s=1){if("string"==typeof e)return f(n,e,i);if(Array.isArray(e))return Object.assign(f(n,e[0],i),{title:e[1]});{s>3&&console.error("[vuepress] detected a too deep nested sidebar group.");const r=e.children||[];return 0===r.length&&e.path?Object.assign(f(n,e.path,i),{title:e.title}):{type:"group",path:e.path,title:e.title,sidebarDepth:e.sidebarDepth,children:r.map(e=>t(e,n,i,s+1)),collapsable:!1!==e.collapsable}}})(e,s,t)):[]}return[]}function g(t){let e;return(t=t.map(t=>Object.assign({},t))).forEach(t=>{2===t.level?e=t:e&&(e.children||(e.children=[])).push(t)}),t.filter(t=>2===t.level)}function v(t){return Object.assign(t,{type:t.items&&t.items.length?"links":"link"})}},227:function(t,e,n){"use strict";var i=n(12),s=n(60)(3);i(i.P+i.F*!n(40)([].some,!0),"Array",{some:function(t){return s(this,t,arguments[1])}})},229:function(t,e,n){},230:function(t,e,n){},231:function(t,e,n){},232:function(t,e,n){},233:function(t,e,n){},234:function(t,e,n){},235:function(t,e,n){},236:function(t,e,n){},237:function(t,e,n){},238:function(t,e,n){},239:function(t,e,n){},240:function(t,e,n){},241:function(t,e,n){},243:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},244:function(t,e,n){"use strict";var i=n(22),s=n(25),r=n(134),a=n(135);n(136)("match",1,function(t,e,n,o){return[function(n){var i=t(this),s=null==n?void 0:n[e];return void 0!==s?s.call(n,i):new RegExp(n)[e](String(i))},function(t){var e=o(n,t,this);if(e.done)return e.value;var u=i(t),c=String(this);if(!u.global)return a(u,c);var l=u.unicode;u.lastIndex=0;for(var h,p=[],f=0;null!==(h=a(u,c));){var d=String(h[0]);p[f]=d,""===d&&(u.lastIndex=r(c,s(u.lastIndex),l)),f++}return 0===f?null:p}]})},245:function(t,e,n){"use strict";n.r(e);n(227);var i=n(226),s={name:"SidebarGroup",props:["item","open","collapsable","depth"],components:{DropdownTransition:n(246).a},beforeCreate:function(){this.$options.components.SidebarLinks=n(245).default},methods:{isActive:i.e}},r=(n(274),n(37)),a=Object(r.a)(s,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("section",{staticClass:"sidebar-group",class:[{collapsable:t.collapsable,"is-sub-group":0!==t.depth},"depth-"+t.depth]},[t.item.path?n("router-link",{staticClass:"sidebar-heading clickable",class:{open:t.open,active:t.isActive(t.$route,t.item.path)},attrs:{to:t.item.path},nativeOn:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]):n("p",{staticClass:"sidebar-heading",class:{open:t.open},on:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]),t._v(" "),n("DropdownTransition",[t.open||!t.collapsable?n("SidebarLinks",{staticClass:"sidebar-group-items",attrs:{items:t.item.children,sidebarDepth:t.item.sidebarDepth,depth:t.depth+1}}):t._e()],1)],1)},[],!1,null,null,null).exports;n(59);function o(t,e,n,i){return t("router-link",{props:{to:e,activeClass:"",exactActiveClass:""},class:{active:i,"sidebar-link":!0}},n)}function u(t,e,n,s,r){var a=arguments.length>5&&void 0!==arguments[5]?arguments[5]:1;return!e||a>r?null:t("ul",{class:"sidebar-sub-headers"},e.map(function(e){var c=Object(i.e)(s,n+"#"+e.slug);return t("li",{class:"sidebar-sub-header"},[o(t,n+"#"+e.slug,e.title,c),u(t,e.children,n,s,r,a+1)])}))}var c={functional:!0,props:["item","sidebarDepth"],render:function(t,e){var n=e.parent,s=n.$page,r=(n.$site,n.$route),a=n.$themeConfig,c=n.$themeLocaleConfig,l=e.props,h=l.item,p=l.sidebarDepth,f=Object(i.e)(r,h.path),d="auto"===h.type?f||h.children.some(function(t){return Object(i.e)(r,h.basePath+"#"+t.slug)}):f,g=o(t,h.path,h.title||h.path,d),v=s.frontmatter.sidebarDepth||p||c.sidebarDepth||a.sidebarDepth,m=null==v?1:v,b=c.displayAllHeaders||a.displayAllHeaders;return"auto"===h.type?[g,u(t,h.children,h.basePath,r,m)]:(d||b)&&h.headers&&!i.d.test(h.path)?[g,u(t,Object(i.c)(h.headers),h.path,r,m)]:g}};n(275);var l={name:"SidebarLinks",components:{SidebarGroup:a,SidebarLink:Object(r.a)(c,void 0,void 0,!1,null,null,null).exports},props:["items","depth","sidebarDepth"],data:function(){return{openGroupIndex:0}},created:function(){this.refreshIndex()},watch:{$route:function(){this.refreshIndex()}},methods:{refreshIndex:function(){var t=function(t,e){for(var n=0;n-1&&(this.openGroupIndex=t)},toggleGroup:function(t){this.openGroupIndex=t===this.openGroupIndex?-1:t},isActive:function(t){return Object(i.e)(this.$route,t.regularPath)}}},h=Object(r.a)(l,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.items.length?n("ul",{staticClass:"sidebar-links"},t._l(t.items,function(e,i){return n("li",{key:i},["group"===e.type?n("SidebarGroup",{attrs:{item:e,open:i===t.openGroupIndex,collapsable:e.collapsable||e.collapsible,depth:t.depth},on:{toggle:function(e){return t.toggleGroup(i)}}}):n("SidebarLink",{attrs:{sidebarDepth:t.sidebarDepth,item:e}})],1)}),0):t._e()},[],!1,null,null,null);e.default=h.exports},246:function(t,e,n){"use strict";var i={name:"DropdownTransition",methods:{setHeight:function(t){t.style.height=t.scrollHeight+"px"},unsetHeight:function(t){t.style.height=""}}},s=(n(269),n(37)),r=Object(s.a)(i,function(){var t=this.$createElement;return(this._self._c||t)("transition",{attrs:{name:"dropdown"},on:{enter:this.setHeight,"after-enter":this.unsetHeight,"before-leave":this.setHeight}},[this._t("default")],2)},[],!1,null,null,null);e.a=r.exports},248:function(t,e,n){"use strict";n(249)("link",function(t){return function(e){return t(this,"a","href",e)}})},249:function(t,e,n){var i=n(12),s=n(38),r=n(24),a=/"/g,o=function(t,e,n,i){var s=String(r(t)),o="<"+e;return""!==n&&(o+=" "+n+'="'+String(i).replace(a,""")+'"'),o+">"+s+""};t.exports=function(t,e){var n={};n[t]=e(o),i(i.P+i.F*s(function(){var e=""[t]('"');return e!==e.toLowerCase()||e.split('"').length>3}),"String",n)}},250:function(t,e,n){"use strict";var i=n(229);n.n(i).a},251:function(t,e,n){t.exports=n(252)},252:function(t,e,n){n(253),t.exports=n(0).parseInt},253:function(t,e,n){var i=n(1),s=n(254);i(i.G+i.F*(parseInt!=s),{parseInt:s})},254:function(t,e,n){var i=n(2).parseInt,s=n(255).trim,r=n(243),a=/^[-+]?0[xX]/;t.exports=8!==i(r+"08")||22!==i(r+"0x16")?function(t,e){var n=s(String(t),3);return i(n,e>>>0||(a.test(n)?16:10))}:i},255:function(t,e,n){var i=n(1),s=n(61),r=n(14),a=n(243),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},256:function(t,e,n){"use strict";var i=n(230);n.n(i).a},257:function(t,e,n){"use strict";var i=n(12),s=n(132)(!1),r=[].indexOf,a=!!r&&1/[1].indexOf(1,-0)<0;i(i.P+i.F*(a||!n(40)(r)),"Array",{indexOf:function(t){return a?r.apply(this,arguments)||0:s(this,t,arguments[1])}})},258:function(t,e,n){"use strict";n(259)("trim",function(t){return function(){return t(this,3)}})},259:function(t,e,n){var i=n(12),s=n(24),r=n(38),a=n(260),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},260:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},261:function(t,e,n){"use strict";var i=n(231);n.n(i).a},262:function(t,e,n){var i=n(13),s=n(263),r=n(39).f,a=n(267).f,o=n(133),u=n(137),c=i.RegExp,l=c,h=c.prototype,p=/a/g,f=/a/g,d=new c(p)!==p;if(n(21)&&(!d||n(38)(function(){return f[n(6)("match")]=!1,c(p)!=p||c(f)==f||"/a/i"!=c(p,"i")}))){c=function(t,e){var n=this instanceof c,i=o(t),r=void 0===e;return!n&&i&&t.constructor===c&&r?t:s(d?new l(i&&!r?t.source:t,e):l((i=t instanceof c)?t.source:t,i&&r?u.call(t):e),n?this:h,c)};for(var g=function(t){t in c||r(c,t,{configurable:!0,get:function(){return l[t]},set:function(e){l[t]=e}})},v=a(l),m=0;v.length>m;)g(v[m++]);h.constructor=c,c.prototype=h,n(41)(i,"RegExp",c)}n(268)("RegExp")},263:function(t,e,n){var i=n(23),s=n(264).set;t.exports=function(t,e,n){var r,a=e.constructor;return a!==n&&"function"==typeof a&&(r=a.prototype)!==n.prototype&&i(r)&&s&&s(t,r),t}},264:function(t,e,n){var i=n(23),s=n(22),r=function(t,e){if(s(t),!i(e)&&null!==e)throw TypeError(e+": can't set as prototype!")};t.exports={set:Object.setPrototypeOf||("__proto__"in{}?function(t,e,i){try{(i=n(92)(Function.call,n(265).f(Object.prototype,"__proto__").set,2))(t,[]),e=!(t instanceof Array)}catch(t){e=!0}return function(t,n){return r(t,n),e?t.__proto__=n:i(t,n),t}}({},!1):void 0),check:r}},265:function(t,e,n){var i=n(266),s=n(91),r=n(62),a=n(130),o=n(42),u=n(129),c=Object.getOwnPropertyDescriptor;e.f=n(21)?c:function(t,e){if(t=r(t),e=a(e,!0),u)try{return c(t,e)}catch(t){}if(o(t,e))return s(!i.f.call(t,e),t[e])}},266:function(t,e){e.f={}.propertyIsEnumerable},267:function(t,e,n){var i=n(131),s=n(93).concat("length","prototype");e.f=Object.getOwnPropertyNames||function(t){return i(t,s)}},268:function(t,e,n){"use strict";var i=n(13),s=n(39),r=n(21),a=n(6)("species");t.exports=function(t){var e=i[t];r&&e&&!e[a]&&s.f(e,a,{configurable:!0,get:function(){return this}})}},269:function(t,e,n){"use strict";var i=n(232);n.n(i).a},270:function(t,e,n){"use strict";var i=n(233);n.n(i).a},271:function(t,e,n){"use strict";var i=n(234);n.n(i).a},272:function(t,e,n){"use strict";var i=n(235);n.n(i).a},273:function(t,e,n){"use strict";var i=n(236);n.n(i).a},274:function(t,e,n){"use strict";var i=n(237);n.n(i).a},275:function(t,e,n){"use strict";var i=n(238);n.n(i).a},276:function(t,e,n){"use strict";var i=n(239);n.n(i).a},277:function(t,e,n){"use strict";var i=n(240);n.n(i).a},278:function(t,e,n){"use strict";var i=n(241);n.n(i).a},280:function(t,e,n){"use strict";n.r(e);var i=n(34),s=n.n(i),r=(n(227),n(248),n(226)),a={props:{item:{required:!0}},computed:{link:function(){return Object(r.b)(this.item.link)},exact:function(){var t=this;return this.$site.locales?s()(this.$site.locales).some(function(e){return e===t.link}):"/"===this.link}},methods:{isExternal:r.f,isMailto:r.g,isTel:r.h}},o=n(37),u=Object(o.a)(a,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.isExternal(t.link)?n("a",{staticClass:"nav-link external",attrs:{href:t.link,target:t.isMailto(t.link)||t.isTel(t.link)?null:"_blank",rel:t.isMailto(t.link)||t.isTel(t.link)?null:"noopener noreferrer"}},[t._v("\n "+t._s(t.item.text)+"\n "),n("OutboundLink")],1):n("router-link",{staticClass:"nav-link",attrs:{to:t.link,exact:t.exact}},[t._v(t._s(t.item.text))])},[],!1,null,null,null).exports,c={components:{NavLink:u},computed:{data:function(){return this.$page.frontmatter},actionLink:function(){return{link:this.data.actionLink,text:this.data.actionText}}}},l=(n(250),Object(o.a)(c,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("main",{staticClass:"home",attrs:{"aria-labelledby":"main-title"}},[n("header",{staticClass:"hero"},[t.data.heroImage?n("img",{attrs:{src:t.$withBase(t.data.heroImage),alt:"hero"}}):t._e(),t._v(" "),n("h1",{attrs:{id:"main-title"}},[t._v(t._s(t.data.heroText||t.$title||"Hello"))]),t._v(" "),n("p",{staticClass:"description"},[t._v("\n "+t._s(t.data.tagline||t.$description||"Welcome to your VuePress site")+"\n ")]),t._v(" "),t.data.actionText&&t.data.actionLink?n("p",{staticClass:"action"},[n("NavLink",{staticClass:"action-button",attrs:{item:t.actionLink}})],1):t._e()]),t._v(" "),t.data.features&&t.data.features.length?n("div",{staticClass:"features"},t._l(t.data.features,function(e,i){return n("div",{key:i,staticClass:"feature"},[n("h2",[t._v(t._s(e.title))]),t._v(" "),n("p",[t._v(t._s(e.details))])])}),0):t._e(),t._v(" "),n("Content",{staticClass:"custom"}),t._v(" "),t.data.footer?n("div",{staticClass:"footer"},[t._v("\n "+t._s(t.data.footer)+"\n ")]):t._e()],1)},[],!1,null,null,null).exports),h=n(251),p=n.n(h),f=(n(256),Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"sidebar-button",on:{click:function(e){return t.$emit("toggle-sidebar")}}},[n("svg",{staticClass:"icon",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",role:"img",viewBox:"0 0 448 512"}},[n("path",{attrs:{fill:"currentColor",d:"M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"}})])])},[],!1,null,null,null).exports),d=(n(244),n(63),n(107)),g=n.n(d),v=n(18),m=n.n(v),b=(n(257),n(258),{data:function(){return{query:"",focused:!1,focusIndex:0}},computed:{showSuggestions:function(){return this.focused&&this.suggestions&&this.suggestions.length},suggestions:function(){var t=this.query.trim().toLowerCase();if(t){for(var e=this.$site.pages,n=this.$localePath,i=function(e){return e.title&&e.title.toLowerCase().indexOf(t)>-1},s=[],r=0;r=5);r++){var a=e[r];if(this.getPageLocalePath(a)===n&&this.isSearchable(a))if(i(a))s.push(a);else if(a.headers)for(var o=0;o=5);o++){var u=a.headers[o];i(u)&&s.push(m()({},a,{path:a.path+"#"+u.slug,header:u}))}}return s}},alignRight:function(){return(this.$site.themeConfig.nav||[]).length+(this.$site.repo?1:0)<=2}},methods:{getPageLocalePath:function(t){for(var e in this.$site.locales||{})if("/"!==e&&0===t.path.indexOf(e))return e;return"/"},isSearchable:function(t){var e=null;return null===e||(e=g()(e)?e:new Array(e)).filter(function(e){return t.path.match(e)}).length>0},onUp:function(){this.showSuggestions&&(this.focusIndex>0?this.focusIndex--:this.focusIndex=this.suggestions.length-1)},onDown:function(){this.showSuggestions&&(this.focusIndex "+t._s(e.header.title))]):t._e()])])}),0):t._e()])},[],!1,null,null,null).exports),k=(n(262),n(56)),x=(n(128),n(59),{components:{NavLink:u,DropdownTransition:n(246).a},data:function(){return{open:!1}},props:{item:{required:!0}},methods:{toggle:function(){this.open=!this.open}}}),$=(n(270),{components:{NavLink:u,DropdownLink:Object(o.a)(x,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"dropdown-wrapper",class:{open:t.open}},[n("a",{staticClass:"dropdown-title",on:{click:t.toggle}},[n("span",{staticClass:"title"},[t._v(t._s(t.item.text))]),t._v(" "),n("span",{staticClass:"arrow",class:t.open?"down":"right"})]),t._v(" "),n("DropdownTransition",[n("ul",{directives:[{name:"show",rawName:"v-show",value:t.open,expression:"open"}],staticClass:"nav-dropdown"},t._l(t.item.items,function(e,i){return n("li",{key:e.link||i,staticClass:"dropdown-item"},["links"===e.type?n("h4",[t._v(t._s(e.text))]):t._e(),t._v(" "),"links"===e.type?n("ul",{staticClass:"dropdown-subitem-wrapper"},t._l(e.items,function(t){return n("li",{key:t.link,staticClass:"dropdown-subitem"},[n("NavLink",{attrs:{item:t}})],1)}),0):n("NavLink",{attrs:{item:e}})],1)}),0)])],1)},[],!1,null,null,null).exports},computed:{userNav:function(){return this.$themeLocaleConfig.nav||this.$site.themeConfig.nav||[]},nav:function(){var t=this,e=this.$site.locales;if(e&&s()(e).length>1){var n=this.$page.path,i=this.$router.options.routes,r=this.$site.themeConfig.locales||{},a={text:this.$themeLocaleConfig.selectText||"Languages",items:s()(e).map(function(s){var a,o=e[s],u=r[s]&&r[s].label||o.lang;return o.lang===t.$lang?a=n:(a=n.replace(t.$localeConfig.path,s),i.some(function(t){return t.path===a})||(a=s)),{text:u,link:a}})};return[].concat(Object(k.a)(this.userNav),[a])}return this.userNav},userLinks:function(){return(this.nav||[]).map(function(t){return m()(Object(r.k)(t),{items:(t.items||[]).map(r.k)})})},repoLink:function(){var t=this.$site.themeConfig.repo;if(t)return/^https?:/.test(t)?t:"https://github.com/".concat(t)},repoLabel:function(){if(this.repoLink){if(this.$site.themeConfig.repoLabel)return this.$site.themeConfig.repoLabel;for(var t=this.repoLink.match(/^https?:\/\/[^\/]+/)[0],e=["GitHub","GitLab","Bitbucket"],n=0;nMath.abs(n)&&Math.abs(e)>40&&(e>0&&this.touchStart.x<=80?this.toggleSidebar(!0):this.toggleSidebar(!1))}}}),T=(n(277),n(278),Object(o.a)(E,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"theme-container",class:t.pageClasses,on:{touchstart:t.onTouchStart,touchend:t.onTouchEnd}},[t.shouldShowNavbar?n("Navbar",{on:{"toggle-sidebar":t.toggleSidebar}}):t._e(),t._v(" "),n("div",{staticClass:"sidebar-mask",on:{click:function(e){return t.toggleSidebar(!1)}}}),t._v(" "),n("Sidebar",{attrs:{items:t.sidebarItems},on:{"toggle-sidebar":t.toggleSidebar}},[t._t("sidebar-top",null,{slot:"top"}),t._v(" "),t._t("sidebar-bottom",null,{slot:"bottom"})],2),t._v(" "),t.$page.frontmatter.home?n("Home"):n("Page",{attrs:{"sidebar-items":t.sidebarItems}},[t._t("page-top",null,{slot:"top"}),t._v(" "),t._t("page-bottom",null,{slot:"bottom"})],2)],1)},[],!1,null,null,null));e.default=T.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/20.fec34c17.js b/docs/assets/js/20.32d6eb46.js similarity index 91% rename from docs/.vuepress/dist/assets/js/20.fec34c17.js rename to docs/assets/js/20.32d6eb46.js index bb8727886..074367a86 100644 --- a/docs/.vuepress/dist/assets/js/20.fec34c17.js +++ b/docs/assets/js/20.32d6eb46.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{395:function(t,r,a){"use strict";a.r(r);var e=a(37),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/6506c10/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/6506c10/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.06ea278f.js b/docs/assets/js/200.9ffef669.js similarity index 94% rename from docs/.vuepress/dist/assets/js/200.06ea278f.js rename to docs/assets/js/200.9ffef669.js index cf275a489..f6c61aff2 100644 --- a/docs/.vuepress/dist/assets/js/200.06ea278f.js +++ b/docs/assets/js/200.9ffef669.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[200],{326:function(t,s,e){"use strict";e.r(s);var r=e(37),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/6506c10/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.69833266.js b/docs/assets/js/201.23c1b270.js similarity index 95% rename from docs/.vuepress/dist/assets/js/201.69833266.js rename to docs/assets/js/201.23c1b270.js index 1d5c92b94..bd720c3eb 100644 --- a/docs/.vuepress/dist/assets/js/201.69833266.js +++ b/docs/assets/js/201.23c1b270.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{325:function(t,e,n){"use strict";n.r(e);var s=n(37),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/6506c10/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.5eecc4e9.js b/docs/assets/js/202.4c13b5ef.js similarity index 94% rename from docs/.vuepress/dist/assets/js/202.5eecc4e9.js rename to docs/assets/js/202.4c13b5ef.js index 11cb37332..b479e1525 100644 --- a/docs/.vuepress/dist/assets/js/202.5eecc4e9.js +++ b/docs/assets/js/202.4c13b5ef.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{324:function(t,e,s){"use strict";s.r(e);var a=s(37),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/6506c10/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.36b81107.js b/docs/assets/js/203.f3b79198.js similarity index 95% rename from docs/.vuepress/dist/assets/js/203.36b81107.js rename to docs/assets/js/203.f3b79198.js index 2fcf2bbc7..bd366c986 100644 --- a/docs/.vuepress/dist/assets/js/203.36b81107.js +++ b/docs/assets/js/203.f3b79198.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{323:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.d6cc92ca.js b/docs/assets/js/204.298dd953.js similarity index 95% rename from docs/.vuepress/dist/assets/js/204.d6cc92ca.js rename to docs/assets/js/204.298dd953.js index 4ebf8a538..13fdc9eb5 100644 --- a/docs/.vuepress/dist/assets/js/204.d6cc92ca.js +++ b/docs/assets/js/204.298dd953.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{322:function(t,s,n){"use strict";n.r(s);var a=n(37),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/6506c10/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.b8a7e0cb.js b/docs/assets/js/205.c653ee4f.js similarity index 93% rename from docs/.vuepress/dist/assets/js/205.b8a7e0cb.js rename to docs/assets/js/205.c653ee4f.js index e6f50143a..8cbb16aa5 100644 --- a/docs/.vuepress/dist/assets/js/205.b8a7e0cb.js +++ b/docs/assets/js/205.c653ee4f.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{321:function(t,a,s){"use strict";s.r(a);var e=s(37),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/6506c10/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.d65748de.js b/docs/assets/js/206.ec011962.js similarity index 95% rename from docs/.vuepress/dist/assets/js/206.d65748de.js rename to docs/assets/js/206.ec011962.js index e02948a38..5fff57ccc 100644 --- a/docs/.vuepress/dist/assets/js/206.d65748de.js +++ b/docs/assets/js/206.ec011962.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{320:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.27a83dc0.js b/docs/assets/js/207.8af068d7.js similarity index 94% rename from docs/.vuepress/dist/assets/js/207.27a83dc0.js rename to docs/assets/js/207.8af068d7.js index 699dd0ae2..b2068eff7 100644 --- a/docs/.vuepress/dist/assets/js/207.27a83dc0.js +++ b/docs/assets/js/207.8af068d7.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[207],{319:function(t,s,r){"use strict";r.r(s);var a=r(37),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/6506c10/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.33c2f481.js b/docs/assets/js/208.0e944115.js similarity index 94% rename from docs/.vuepress/dist/assets/js/208.33c2f481.js rename to docs/assets/js/208.0e944115.js index 394a915f5..ebef7324b 100644 --- a/docs/.vuepress/dist/assets/js/208.33c2f481.js +++ b/docs/assets/js/208.0e944115.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{318:function(t,s,n){"use strict";n.r(s);var a=n(37),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/6506c10/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.8498127e.js b/docs/assets/js/209.44f2a2f6.js similarity index 95% rename from docs/.vuepress/dist/assets/js/209.8498127e.js rename to docs/assets/js/209.44f2a2f6.js index 6a5b7e441..764774c00 100644 --- a/docs/.vuepress/dist/assets/js/209.8498127e.js +++ b/docs/assets/js/209.44f2a2f6.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[209],{317:function(t,e,s){"use strict";s.r(e);var a=s(37),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/6506c10/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.33f3c84a.js b/docs/assets/js/21.9c3c9411.js similarity index 92% rename from docs/.vuepress/dist/assets/js/21.33f3c84a.js rename to docs/assets/js/21.9c3c9411.js index 873a86bf2..936a7316a 100644 --- a/docs/.vuepress/dist/assets/js/21.33f3c84a.js +++ b/docs/assets/js/21.9c3c9411.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{520:function(t,e,r){"use strict";r.r(e);var s=r(37),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/6506c10/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.55deda89.js b/docs/assets/js/210.83a8f950.js similarity index 95% rename from docs/.vuepress/dist/assets/js/210.55deda89.js rename to docs/assets/js/210.83a8f950.js index aac854660..115882e36 100644 --- a/docs/.vuepress/dist/assets/js/210.55deda89.js +++ b/docs/assets/js/210.83a8f950.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{315:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.7e86d5ba.js b/docs/assets/js/211.03137d99.js similarity index 96% rename from docs/.vuepress/dist/assets/js/211.7e86d5ba.js rename to docs/assets/js/211.03137d99.js index 95f26cf2a..0cfc1cc2f 100644 --- a/docs/.vuepress/dist/assets/js/211.7e86d5ba.js +++ b/docs/assets/js/211.03137d99.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[211],{314:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.d7390e95.js b/docs/assets/js/212.371e37ad.js similarity index 94% rename from docs/.vuepress/dist/assets/js/212.d7390e95.js rename to docs/assets/js/212.371e37ad.js index e06759045..6a01815cc 100644 --- a/docs/.vuepress/dist/assets/js/212.d7390e95.js +++ b/docs/assets/js/212.371e37ad.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{312:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.693cbd68.js b/docs/assets/js/213.a202cec8.js similarity index 94% rename from docs/.vuepress/dist/assets/js/213.693cbd68.js rename to docs/assets/js/213.a202cec8.js index c731324ce..ba35db75c 100644 --- a/docs/.vuepress/dist/assets/js/213.693cbd68.js +++ b/docs/assets/js/213.a202cec8.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[213],{313:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.b58aaf1c.js b/docs/assets/js/214.faf6d400.js similarity index 94% rename from docs/.vuepress/dist/assets/js/214.b58aaf1c.js rename to docs/assets/js/214.faf6d400.js index a38f77fdc..955ec9747 100644 --- a/docs/.vuepress/dist/assets/js/214.b58aaf1c.js +++ b/docs/assets/js/214.faf6d400.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{308:function(t,s,a){"use strict";a.r(s);var e=a(37),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/6506c10/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.b803123d.js b/docs/assets/js/215.17d0c0c2.js similarity index 94% rename from docs/.vuepress/dist/assets/js/215.b803123d.js rename to docs/assets/js/215.17d0c0c2.js index c496cfa93..98bf9a949 100644 --- a/docs/.vuepress/dist/assets/js/215.b803123d.js +++ b/docs/assets/js/215.17d0c0c2.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{311:function(s,t,a){"use strict";a.r(t);var e=a(37),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/6506c10/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.e6d7df8e.js b/docs/assets/js/216.80eaf261.js similarity index 94% rename from docs/.vuepress/dist/assets/js/216.e6d7df8e.js rename to docs/assets/js/216.80eaf261.js index 2e5973eca..b1b153ba7 100644 --- a/docs/.vuepress/dist/assets/js/216.e6d7df8e.js +++ b/docs/assets/js/216.80eaf261.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{310:function(t,s,n){"use strict";n.r(s);var a=n(37),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/6506c10/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.f1faffcf.js b/docs/assets/js/217.e66c4815.js similarity index 94% rename from docs/.vuepress/dist/assets/js/217.f1faffcf.js rename to docs/assets/js/217.e66c4815.js index a9e6052ad..c9a5cc15c 100644 --- a/docs/.vuepress/dist/assets/js/217.f1faffcf.js +++ b/docs/assets/js/217.e66c4815.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{309:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.b545b399.js b/docs/assets/js/218.05db5f80.js similarity index 93% rename from docs/.vuepress/dist/assets/js/218.b545b399.js rename to docs/assets/js/218.05db5f80.js index 85f5b2930..bcb869bd0 100644 --- a/docs/.vuepress/dist/assets/js/218.b545b399.js +++ b/docs/assets/js/218.05db5f80.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{307:function(t,s,n){"use strict";n.r(s);var e=n(37),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/6506c10/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.d691d2fa.js b/docs/assets/js/219.c6da797f.js similarity index 94% rename from docs/.vuepress/dist/assets/js/219.d691d2fa.js rename to docs/assets/js/219.c6da797f.js index 004a47451..f5f6009c8 100644 --- a/docs/.vuepress/dist/assets/js/219.d691d2fa.js +++ b/docs/assets/js/219.c6da797f.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{306:function(t,e,s){"use strict";s.r(e);var a=s(37),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/6506c10/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/6506c10/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.b3e519f1.js b/docs/assets/js/22.7cd88b6d.js similarity index 93% rename from docs/.vuepress/dist/assets/js/22.b3e519f1.js rename to docs/assets/js/22.7cd88b6d.js index 13f7cf828..191c2c71b 100644 --- a/docs/.vuepress/dist/assets/js/22.b3e519f1.js +++ b/docs/assets/js/22.7cd88b6d.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{282:function(t,e,r){"use strict";r.r(e);var s=r(37),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/6506c10/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.732ab40d.js b/docs/assets/js/220.0ae8e3e2.js similarity index 95% rename from docs/.vuepress/dist/assets/js/220.732ab40d.js rename to docs/assets/js/220.0ae8e3e2.js index 5ea3cbf9f..232ea0721 100644 --- a/docs/.vuepress/dist/assets/js/220.732ab40d.js +++ b/docs/assets/js/220.0ae8e3e2.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{305:function(t,e,n){"use strict";n.r(e);var s=n(37),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/6506c10/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.3ab0b29e.js b/docs/assets/js/221.17fa484d.js similarity index 95% rename from docs/.vuepress/dist/assets/js/221.3ab0b29e.js rename to docs/assets/js/221.17fa484d.js index ed77a9802..7a297bbe3 100644 --- a/docs/.vuepress/dist/assets/js/221.3ab0b29e.js +++ b/docs/assets/js/221.17fa484d.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{304:function(t,e,a){"use strict";a.r(e);var n=a(37),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/6506c10/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.b6cd6ae0.js b/docs/assets/js/222.b6cd6ae0.js new file mode 100644 index 000000000..69b7e7da1 --- /dev/null +++ b/docs/assets/js/222.b6cd6ae0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{303:function(t,e,n){"use strict";n.r(e);var s=n(37),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/223.ffbde94e.js b/docs/assets/js/223.ffbde94e.js new file mode 100644 index 000000000..76994ed92 --- /dev/null +++ b/docs/assets/js/223.ffbde94e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[223],{302:function(t,e,n){"use strict";n.r(e);var s=n(37),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.d7a30918.js b/docs/assets/js/224.d7a30918.js new file mode 100644 index 000000000..92b2dabe3 --- /dev/null +++ b/docs/assets/js/224.d7a30918.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{301:function(t,e,n){"use strict";n.r(e);var s=n(37),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.ada740a5.js b/docs/assets/js/225.ada740a5.js new file mode 100644 index 000000000..1157fe1cd --- /dev/null +++ b/docs/assets/js/225.ada740a5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{300:function(t,e,n){"use strict";n.r(e);var s=n(37),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.6f0c6711.js b/docs/assets/js/226.6f0c6711.js new file mode 100644 index 000000000..79e9b1a80 --- /dev/null +++ b/docs/assets/js/226.6f0c6711.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{299:function(t,e,n){"use strict";n.r(e);var s=n(37),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/227.e12cc1c1.js b/docs/assets/js/227.e12cc1c1.js new file mode 100644 index 000000000..59244346f --- /dev/null +++ b/docs/assets/js/227.e12cc1c1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[227],{298:function(t,e,n){"use strict";n.r(e);var s=n(37),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.3374c974.js b/docs/assets/js/228.1fd87b4d.js similarity index 95% rename from docs/.vuepress/dist/assets/js/228.3374c974.js rename to docs/assets/js/228.1fd87b4d.js index abcfa4cfe..032c43b6f 100644 --- a/docs/.vuepress/dist/assets/js/228.3374c974.js +++ b/docs/assets/js/228.1fd87b4d.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{297:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.f257d38e.js b/docs/assets/js/229.f257d38e.js new file mode 100644 index 000000000..9bd95b885 --- /dev/null +++ b/docs/assets/js/229.f257d38e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{296:function(t,e,n){"use strict";n.r(e);var s=n(37),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/23.d960b1d3.js b/docs/assets/js/23.990a55fa.js similarity index 79% rename from docs/.vuepress/dist/assets/js/23.d960b1d3.js rename to docs/assets/js/23.990a55fa.js index 2eb321685..6cfc0a7d2 100644 --- a/docs/.vuepress/dist/assets/js/23.d960b1d3.js +++ b/docs/assets/js/23.990a55fa.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{424: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("Serialize")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{404:function(t,e,r){"use strict";r.r(e);var a=r(37),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("Serialize")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/db/classes/_fileflatdb_file_.file.html"}},[t._v("File")])],1)])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/230.67d69ce6.js b/docs/assets/js/230.ab9c37a9.js similarity index 92% rename from docs/.vuepress/dist/assets/js/230.67d69ce6.js rename to docs/assets/js/230.ab9c37a9.js index ba7cfdee4..f2740cf6d 100644 --- a/docs/.vuepress/dist/assets/js/230.67d69ce6.js +++ b/docs/assets/js/230.ab9c37a9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{295:function(t,s,r){"use strict";r.r(s);var e=r(37),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/6506c10/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.b3ed861d.js b/docs/assets/js/231.c2ca79bf.js similarity index 94% rename from docs/.vuepress/dist/assets/js/231.b3ed861d.js rename to docs/assets/js/231.c2ca79bf.js index 9231aaeac..956ec7b05 100644 --- a/docs/.vuepress/dist/assets/js/231.b3ed861d.js +++ b/docs/assets/js/231.c2ca79bf.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{294:function(t,s,n){"use strict";n.r(s);var e=n(37),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/6506c10/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.67759a82.js b/docs/assets/js/232.4d2da9d9.js similarity index 94% rename from docs/.vuepress/dist/assets/js/232.67759a82.js rename to docs/assets/js/232.4d2da9d9.js index 0df709318..ae6dfd3dc 100644 --- a/docs/.vuepress/dist/assets/js/232.67759a82.js +++ b/docs/assets/js/232.4d2da9d9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{293:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.6411d217.js b/docs/assets/js/233.22d3eafb.js similarity index 92% rename from docs/.vuepress/dist/assets/js/233.6411d217.js rename to docs/assets/js/233.22d3eafb.js index 048ab39bd..14f1d13c7 100644 --- a/docs/.vuepress/dist/assets/js/233.6411d217.js +++ b/docs/assets/js/233.22d3eafb.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[233],{292:function(t,s,r){"use strict";r.r(s);var e=r(37),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/6506c10/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.215b2134.js b/docs/assets/js/234.50d6de07.js similarity index 87% rename from docs/.vuepress/dist/assets/js/234.215b2134.js rename to docs/assets/js/234.50d6de07.js index 5f34e0735..2b5aedb15 100644 --- a/docs/.vuepress/dist/assets/js/234.215b2134.js +++ b/docs/assets/js/234.50d6de07.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{291:function(t,e,n){"use strict";n.r(e);var r=n(37),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/6506c10/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.bb6bf091.js b/docs/assets/js/235.85d97ec2.js similarity index 91% rename from docs/.vuepress/dist/assets/js/235.bb6bf091.js rename to docs/assets/js/235.85d97ec2.js index 61d383117..2d3316427 100644 --- a/docs/.vuepress/dist/assets/js/235.bb6bf091.js +++ b/docs/assets/js/235.85d97ec2.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{289:function(t,e,a){"use strict";a.r(e);var r=a(37),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/6506c10/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/6506c10/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.a1743b72.js b/docs/assets/js/236.0c3a5469.js similarity index 96% rename from docs/.vuepress/dist/assets/js/236.a1743b72.js rename to docs/assets/js/236.0c3a5469.js index 74b7310e2..0f521a24d 100644 --- a/docs/.vuepress/dist/assets/js/236.a1743b72.js +++ b/docs/assets/js/236.0c3a5469.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{290:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.cf91c6d9.js b/docs/assets/js/237.7a83b0a4.js similarity index 96% rename from docs/.vuepress/dist/assets/js/237.cf91c6d9.js rename to docs/assets/js/237.7a83b0a4.js index e622f66ea..e91bbd291 100644 --- a/docs/.vuepress/dist/assets/js/237.cf91c6d9.js +++ b/docs/assets/js/237.7a83b0a4.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{288:function(t,a,n){"use strict";n.r(a);var e=n(37),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/6506c10/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.daad0e47.js b/docs/assets/js/238.968eb18b.js similarity index 96% rename from docs/.vuepress/dist/assets/js/238.daad0e47.js rename to docs/assets/js/238.968eb18b.js index 8c114ac81..7b81d28c3 100644 --- a/docs/.vuepress/dist/assets/js/238.daad0e47.js +++ b/docs/assets/js/238.968eb18b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{287:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.140e9afc.js b/docs/assets/js/239.c1aaee4b.js similarity index 94% rename from docs/.vuepress/dist/assets/js/239.140e9afc.js rename to docs/assets/js/239.c1aaee4b.js index a2132cf82..0222a57be 100644 --- a/docs/.vuepress/dist/assets/js/239.140e9afc.js +++ b/docs/assets/js/239.c1aaee4b.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{286:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.cde54b27.js b/docs/assets/js/24.9e330bc7.js similarity index 96% rename from docs/.vuepress/dist/assets/js/24.cde54b27.js rename to docs/assets/js/24.9e330bc7.js index 157eecf83..c1ad4a064 100644 --- a/docs/.vuepress/dist/assets/js/24.cde54b27.js +++ b/docs/assets/js/24.9e330bc7.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{407:function(t,s,n){"use strict";n.r(s);var a=n(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.4390c353.js b/docs/assets/js/240.a80b78b9.js similarity index 96% rename from docs/.vuepress/dist/assets/js/240.4390c353.js rename to docs/assets/js/240.a80b78b9.js index f3eb49826..811cebe98 100644 --- a/docs/.vuepress/dist/assets/js/240.4390c353.js +++ b/docs/assets/js/240.a80b78b9.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{284:function(t,a,e){"use strict";e.r(a);var s=e(37),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/6506c10/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.d3f5e4de.js b/docs/assets/js/241.d58a17f4.js similarity index 95% rename from docs/.vuepress/dist/assets/js/241.d3f5e4de.js rename to docs/assets/js/241.d58a17f4.js index 591d409be..ed24cca1f 100644 --- a/docs/.vuepress/dist/assets/js/241.d3f5e4de.js +++ b/docs/assets/js/241.d58a17f4.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{283:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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.733a2eb7.js b/docs/assets/js/242.047b0e55.js similarity index 95% rename from docs/.vuepress/dist/assets/js/242.733a2eb7.js rename to docs/assets/js/242.047b0e55.js index 445269cf9..60f13ede9 100644 --- a/docs/.vuepress/dist/assets/js/242.733a2eb7.js +++ b/docs/assets/js/242.047b0e55.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{401:function(t,a,s){"use strict";s.r(a);var n=s(37),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/6506c10/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/243.4ccb9095.js b/docs/assets/js/243.4ccb9095.js new file mode 100644 index 000000000..d1ce8c968 --- /dev/null +++ b/docs/assets/js/243.4ccb9095.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[243],{225:function(n,w,o){}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/25.d80e6990.js b/docs/assets/js/25.7ec25337.js similarity index 88% rename from docs/.vuepress/dist/assets/js/25.d80e6990.js rename to docs/assets/js/25.7ec25337.js index 1ecb60927..b0ba6c5f5 100644 --- a/docs/.vuepress/dist/assets/js/25.d80e6990.js +++ b/docs/assets/js/25.7ec25337.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{410:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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.bce2e7e5.js b/docs/assets/js/26.aec96c42.js similarity index 91% rename from docs/.vuepress/dist/assets/js/26.bce2e7e5.js rename to docs/assets/js/26.aec96c42.js index 4afc138d3..52266d45f 100644 --- a/docs/.vuepress/dist/assets/js/26.bce2e7e5.js +++ b/docs/assets/js/26.aec96c42.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{413:function(t,e,r){"use strict";r.r(e);var _=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.fc38d8b0.js b/docs/assets/js/27.987b33ff.js similarity index 93% rename from docs/.vuepress/dist/assets/js/27.fc38d8b0.js rename to docs/assets/js/27.987b33ff.js index 77d3e3def..0a64e68f9 100644 --- a/docs/.vuepress/dist/assets/js/27.fc38d8b0.js +++ b/docs/assets/js/27.987b33ff.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{416:function(t,e,r){"use strict";r.r(e);var _=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/28.5729d897.js b/docs/assets/js/28.76ffd36e.js similarity index 82% rename from docs/.vuepress/dist/assets/js/28.5729d897.js rename to docs/assets/js/28.76ffd36e.js index b40ed3a6c..b2a7fe472 100644 --- a/docs/.vuepress/dist/assets/js/28.5729d897.js +++ b/docs/assets/js/28.76ffd36e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{439: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/_disk_.diskdb.html"}},[t._v("DiskDb")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{419:function(t,s,e){"use strict";e.r(s);var a=e(37),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/_disk_.diskdb.html"}},[t._v("DiskDb")])],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/29.8313abe7.js b/docs/assets/js/29.d78bc74d.js similarity index 82% rename from docs/.vuepress/dist/assets/js/29.8313abe7.js rename to docs/assets/js/29.d78bc74d.js index 3f8712ad5..194893ac8 100644 --- a/docs/.vuepress/dist/assets/js/29.8313abe7.js +++ b/docs/assets/js/29.d78bc74d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{442:function(e,t,s){"use strict";s.r(t);var r=s(46),a=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:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{425:function(e,t,s){"use strict";s.r(t);var r=s(37),a=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:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_engines_filetreedb_.filetreedb.html"}},[e._v("FileTreeDb")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/3.b6889e19.js b/docs/assets/js/3.b6889e19.js new file mode 100644 index 000000000..4b5b3aff5 --- /dev/null +++ b/docs/assets/js/3.b6889e19.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[3],{242:function(t,e,n){},279:function(t,e,n){"use strict";var a=n(242);n.n(a).a},285:function(t,e,n){"use strict";n.r(e);var a={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,a=e.slots;return t("span",{class:["badge",n.type,n.vertical]},n.text||a().default)}},r=(n(279),n(37)),i=Object(r.a)(a,void 0,void 0,!1,null,"efceadb8",null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/30.ceb486fb.js b/docs/assets/js/30.05663f82.js similarity index 82% rename from docs/.vuepress/dist/assets/js/30.ceb486fb.js rename to docs/assets/js/30.05663f82.js index f2045e450..c9ecd0dc6 100644 --- a/docs/.vuepress/dist/assets/js/30.ceb486fb.js +++ b/docs/assets/js/30.05663f82.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{445: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:"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/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{422:function(t,s,e){"use strict";e.r(s);var r=e(37),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:"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/_engines_lrudb_.lrudb.html"}},[t._v("LruDb")])],1)]),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/31.b1cd4b7f.js b/docs/assets/js/31.0f6494b1.js similarity index 82% rename from docs/.vuepress/dist/assets/js/31.b1cd4b7f.js rename to docs/assets/js/31.0f6494b1.js index acd13b4c1..21427a677 100644 --- a/docs/.vuepress/dist/assets/js/31.b1cd4b7f.js +++ b/docs/assets/js/31.0f6494b1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{448:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.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/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{428:function(t,e,s){"use strict";s.r(e);var r=s(37),a=Object(r.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/_engines_memorydb_.memorydb.html"}},[t._v("MemoryDb")])],1)]),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/32.c9b1699b.js b/docs/assets/js/32.66541427.js similarity index 83% rename from docs/.vuepress/dist/assets/js/32.c9b1699b.js rename to docs/assets/js/32.66541427.js index e69e68275..b7375e5c6 100644 --- a/docs/.vuepress/dist/assets/js/32.c9b1699b.js +++ b/docs/assets/js/32.66541427.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{431:function(t,s,a){"use strict";a.r(s);var e=a(37),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.9cd88591.js b/docs/assets/js/33.e564d626.js similarity index 82% rename from docs/.vuepress/dist/assets/js/33.9cd88591.js rename to docs/assets/js/33.e564d626.js index 88f951945..28b84530d 100644 --- a/docs/.vuepress/dist/assets/js/33.9cd88591.js +++ b/docs/assets/js/33.e564d626.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{434:function(t,e,a){"use strict";a.r(e);var s=a(37),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/34.3626219a.js b/docs/assets/js/34.80071ca4.js similarity index 82% rename from docs/.vuepress/dist/assets/js/34.3626219a.js rename to docs/assets/js/34.80071ca4.js index 313759853..92141a91a 100644 --- a/docs/.vuepress/dist/assets/js/34.3626219a.js +++ b/docs/assets/js/34.80071ca4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{460: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:"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_compact_.compact.html"}},[t._v("Compact")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{437:function(t,a,s){"use strict";s.r(a);var e=s(37),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:"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_compact_.compact.html"}},[t._v("Compact")])],1)]),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/35.895f12e2.js b/docs/assets/js/35.5c848441.js similarity index 58% rename from docs/.vuepress/dist/assets/js/35.895f12e2.js rename to docs/assets/js/35.5c848441.js index c551ddb6e..3a8c917d4 100644 --- a/docs/.vuepress/dist/assets/js/35.895f12e2.js +++ b/docs/assets/js/35.5c848441.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{457: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([[35],{443:function(t,e,n){"use strict";n.r(e);var s=n(37),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/36.e712ae96.js b/docs/assets/js/36.8230c729.js similarity index 82% rename from docs/.vuepress/dist/assets/js/36.e712ae96.js rename to docs/assets/js/36.8230c729.js index 99aab9503..b9a55f3d6 100644 --- a/docs/.vuepress/dist/assets/js/36.e712ae96.js +++ b/docs/assets/js/36.8230c729.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{440:function(t,e,s){"use strict";s.r(e);var a=s(37),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.e2bf13b0.js b/docs/assets/js/37.56c046f3.js similarity index 82% rename from docs/.vuepress/dist/assets/js/37.e2bf13b0.js rename to docs/assets/js/37.56c046f3.js index b306268e1..6faaa608c 100644 --- a/docs/.vuepress/dist/assets/js/37.e2bf13b0.js +++ b/docs/assets/js/37.56c046f3.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{446:function(t,s,e){"use strict";e.r(s);var a=e(37),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/38.f4b813f8.js b/docs/assets/js/38.ae263165.js similarity index 82% rename from docs/.vuepress/dist/assets/js/38.f4b813f8.js rename to docs/assets/js/38.ae263165.js index 95c8ee707..632307cdb 100644 --- a/docs/.vuepress/dist/assets/js/38.f4b813f8.js +++ b/docs/assets/js/38.ae263165.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{469:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.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:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[e._v("Serialize")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{449:function(e,t,s){"use strict";s.r(t);var a=s(37),r=Object(a.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:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/db/classes/_fileflatdb_serialize_.serialize.html"}},[e._v("Serialize")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/39.eeddab89.js b/docs/assets/js/39.27815369.js similarity index 89% rename from docs/.vuepress/dist/assets/js/39.eeddab89.js rename to docs/assets/js/39.27815369.js index 0fb8d85b4..9da8c78e5 100644 --- a/docs/.vuepress/dist/assets/js/39.eeddab89.js +++ b/docs/assets/js/39.27815369.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{452:function(e,t,a){"use strict";a.r(t);var r=a(37),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/6506c10/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/6506c10/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/6506c10/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/4.fa7ee3a8.js b/docs/assets/js/4.47d9cea3.js similarity index 57% rename from docs/.vuepress/dist/assets/js/4.fa7ee3a8.js rename to docs/assets/js/4.47d9cea3.js index 627945660..b34493d2b 100644 --- a/docs/.vuepress/dist/assets/js/4.fa7ee3a8.js +++ b/docs/assets/js/4.47d9cea3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{250:function(t,e,s){},269:function(t,e,s){"use strict";var n=s(250);s.n(n).a},301:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=(s(269),s(46)),r=Object(i.a)(o,function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("router-link",{attrs:{to:"/"}},[this._v("Take me home.")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{228:function(t,e,s){},247:function(t,e,s){"use strict";var n=s(228);s.n(n).a},281:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=(s(247),s(37)),r=Object(i.a)(o,function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("router-link",{attrs:{to:"/"}},[this._v("Take me home.")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/40.3312f339.js b/docs/assets/js/40.225dcdb9.js similarity index 82% rename from docs/.vuepress/dist/assets/js/40.3312f339.js rename to docs/assets/js/40.225dcdb9.js index f5a68d0f2..8179ba520 100644 --- a/docs/.vuepress/dist/assets/js/40.3312f339.js +++ b/docs/assets/js/40.225dcdb9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{475:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.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/_memory_.memory.html"}},[t._v("Memory")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{455:function(t,e,s){"use strict";s.r(e);var r=s(37),a=Object(r.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/_memory_.memory.html"}},[t._v("Memory")])],1)]),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/41.e1f4f49a.js b/docs/assets/js/41.11847fd4.js similarity index 92% rename from docs/.vuepress/dist/assets/js/41.e1f4f49a.js rename to docs/assets/js/41.11847fd4.js index 5af04b78f..260c329c3 100644 --- a/docs/.vuepress/dist/assets/js/41.e1f4f49a.js +++ b/docs/assets/js/41.11847fd4.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{461:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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.7f31bca0.js b/docs/assets/js/42.ce20ba97.js similarity index 98% rename from docs/.vuepress/dist/assets/js/42.7f31bca0.js rename to docs/assets/js/42.ce20ba97.js index 0270aa912..236816467 100644 --- a/docs/.vuepress/dist/assets/js/42.7f31bca0.js +++ b/docs/assets/js/42.ce20ba97.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{458:function(t,s,a){"use strict";a.r(s);var n=a(37),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/43.2e80fc64.js b/docs/assets/js/43.ed74a24b.js similarity index 99% rename from docs/.vuepress/dist/assets/js/43.2e80fc64.js rename to docs/assets/js/43.ed74a24b.js index 3a752ce7f..57f6dea24 100644 --- a/docs/.vuepress/dist/assets/js/43.2e80fc64.js +++ b/docs/assets/js/43.ed74a24b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{484: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:"load-accounts"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#load-accounts","aria-hidden":"true"}},[t._v("#")]),t._v(" Load Accounts")]),t._v(" "),n("p",[t._v("The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import Keyring class and utility function")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),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 keyword"}},[t._v("default")]),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(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),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("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create account seed for Alice and Bob")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),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("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Bob'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),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("// Create an instance of the Keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),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("Keyring")]),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("// Create their pairs with account seeds. Add to keyring pair dictionary")]),t._v("\n keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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 constant"}},[t._v("ALICE_SEED")]),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 keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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 constant"}},[t._v("BOB_SEED")]),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("// Note that we did not use `addFromAddress` since it does not add the")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// secret key to memory so we cannot later retrieve it with `getPairs`")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve all keyring pairs from the keyring pair dictionary")]),t._v("\n keyring\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPairs")]),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 punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),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 "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),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 console"),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("`\\nAccount with index #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("index"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" has json: `")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toJson")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("address"),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 keyword"}},[t._v("null")]),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(")")]),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"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),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 keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),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 keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),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")])]),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")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{464:function(t,s,n){"use strict";n.r(s);var a=n(37),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:"load-accounts"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#load-accounts","aria-hidden":"true"}},[t._v("#")]),t._v(" Load Accounts")]),t._v(" "),n("p",[t._v("The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import Keyring class and utility function")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),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 keyword"}},[t._v("default")]),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(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),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("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create account seed for Alice and Bob")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),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("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Bob'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),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("// Create an instance of the Keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),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("Keyring")]),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("// Create their pairs with account seeds. Add to keyring pair dictionary")]),t._v("\n keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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 constant"}},[t._v("ALICE_SEED")]),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 keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[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 constant"}},[t._v("BOB_SEED")]),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("// Note that we did not use `addFromAddress` since it does not add the")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// secret key to memory so we cannot later retrieve it with `getPairs`")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve all keyring pairs from the keyring pair dictionary")]),t._v("\n keyring\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPairs")]),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 punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),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 "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),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 console"),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("`\\nAccount with index #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("index"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" has json: `")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toJson")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("address"),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 keyword"}},[t._v("null")]),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(")")]),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"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),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 keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),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 keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),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")])]),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")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/44.e41ceb31.js b/docs/assets/js/44.9c6b37d7.js similarity index 90% rename from docs/.vuepress/dist/assets/js/44.e41ceb31.js rename to docs/assets/js/44.9c6b37d7.js index 0b9b8dd73..90ad6eb58 100644 --- a/docs/.vuepress/dist/assets/js/44.e41ceb31.js +++ b/docs/assets/js/44.9c6b37d7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{487: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:"keyring-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keyring-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Keyring Examples")]),e._v(" "),a("p",[e._v("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.")]),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([[44],{467:function(e,t,a){"use strict";a.r(t);var n=a(37),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:"keyring-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keyring-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Keyring Examples")]),e._v(" "),a("p",[e._v("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.")]),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/45.eb57e290.js b/docs/assets/js/45.431a8f2e.js similarity index 80% rename from docs/.vuepress/dist/assets/js/45.eb57e290.js rename to docs/assets/js/45.431a8f2e.js index 37468c62c..52cdc9229 100644 --- a/docs/.vuepress/dist/assets/js/45.eb57e290.js +++ b/docs/assets/js/45.431a8f2e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{490:function(t,e,i){"use strict";i.r(e);var a=i(46),r=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"create-patricia-trie"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Create Patricia Trie")]),this._v(" "),e("p",[this._v("The following example shows how to create a Patricia Trie.")]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{470:function(t,e,i){"use strict";i.r(e);var a=i(37),r=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"create-patricia-trie"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Create Patricia Trie")]),this._v(" "),e("p",[this._v("The following example shows how to create a Patricia Trie.")]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/46.bc129317.js b/docs/assets/js/46.c848cd8f.js similarity index 81% rename from docs/.vuepress/dist/assets/js/46.bc129317.js rename to docs/assets/js/46.c848cd8f.js index 77c5e5eeb..4507c855a 100644 --- a/docs/.vuepress/dist/assets/js/46.bc129317.js +++ b/docs/assets/js/46.c848cd8f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{493:function(e,t,s){"use strict";s.r(t);var i=s(46),r=Object(i.a)({},function(){var e=this.$createElement,t=this._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"get-set-delete-trie-nodes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#get-set-delete-trie-nodes","aria-hidden":"true"}},[this._v("#")]),this._v(" Get & Set & Delete Trie Nodes")]),this._v(" "),t("p",[this._v("The following example shows how to get, set, and delete nodes of a Patricia Trie.")]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{473:function(e,t,s){"use strict";s.r(t);var i=s(37),r=Object(i.a)({},function(){var e=this.$createElement,t=this._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"get-set-delete-trie-nodes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#get-set-delete-trie-nodes","aria-hidden":"true"}},[this._v("#")]),this._v(" Get & Set & Delete Trie Nodes")]),this._v(" "),t("p",[this._v("The following example shows how to get, set, and delete nodes of a Patricia Trie.")]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/47.308671c3.js b/docs/assets/js/47.e299abb0.js similarity index 82% rename from docs/.vuepress/dist/assets/js/47.308671c3.js rename to docs/assets/js/47.e299abb0.js index f10ccaf83..a64ae21ea 100644 --- a/docs/.vuepress/dist/assets/js/47.308671c3.js +++ b/docs/assets/js/47.e299abb0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[47],{496:function(t,i,a){"use strict";a.r(i);var s=a(46),e=Object(s.a)({},function(){var t=this.$createElement,i=this._self._c||t;return i("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[i("h1",{attrs:{id:"duplicate-patricia-trie-with-snapshot"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#duplicate-patricia-trie-with-snapshot","aria-hidden":"true"}},[this._v("#")]),this._v(" Duplicate Patricia Trie with Snapshot")]),this._v(" "),i("p",[this._v("The following example shows how to duplicate a Patricia Trie by taking a snapshot.")]),this._v(" "),i("p",[i("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);i.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[47],{476:function(t,i,a){"use strict";a.r(i);var s=a(37),e=Object(s.a)({},function(){var t=this.$createElement,i=this._self._c||t;return i("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[i("h1",{attrs:{id:"duplicate-patricia-trie-with-snapshot"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#duplicate-patricia-trie-with-snapshot","aria-hidden":"true"}},[this._v("#")]),this._v(" Duplicate Patricia Trie with Snapshot")]),this._v(" "),i("p",[this._v("The following example shows how to duplicate a Patricia Trie by taking a snapshot.")]),this._v(" "),i("p",[i("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);i.default=e.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/48.7224fd0d.js b/docs/assets/js/48.7b4f8f82.js similarity index 83% rename from docs/.vuepress/dist/assets/js/48.7224fd0d.js rename to docs/assets/js/48.7b4f8f82.js index fd339fbe1..edcfff2a7 100644 --- a/docs/.vuepress/dist/assets/js/48.7224fd0d.js +++ b/docs/assets/js/48.7b4f8f82.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{499:function(t,i,e){"use strict";e.r(i);var a=e(46),s=Object(a.a)({},function(){var t=this.$createElement,i=this._self._c||t;return i("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[i("h1",{attrs:{id:"show-size-and-node-info-of-a-patricia-trie"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#show-size-and-node-info-of-a-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Show Size and Node Info of a Patricia Trie")]),this._v(" "),i("p",[this._v("The following example shows how to show the size and node information of a Patricia Trie.")]),this._v(" "),i("p",[i("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);i.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{479:function(t,i,e){"use strict";e.r(i);var a=e(37),s=Object(a.a)({},function(){var t=this.$createElement,i=this._self._c||t;return i("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[i("h1",{attrs:{id:"show-size-and-node-info-of-a-patricia-trie"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#show-size-and-node-info-of-a-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Show Size and Node Info of a Patricia Trie")]),this._v(" "),i("p",[this._v("The following example shows how to show the size and node information of a Patricia Trie.")]),this._v(" "),i("p",[i("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);i.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/49.de0bc67b.js b/docs/assets/js/49.31a283f8.js similarity index 82% rename from docs/.vuepress/dist/assets/js/49.de0bc67b.js rename to docs/assets/js/49.31a283f8.js index 6eaaf150d..4610f7e9e 100644 --- a/docs/.vuepress/dist/assets/js/49.de0bc67b.js +++ b/docs/assets/js/49.31a283f8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{502:function(t,e,i){"use strict";i.r(e);var a=i(46),s=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"empty-close-drop-a-patricia-trie"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#empty-close-drop-a-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Empty & Close & Drop a Patricia Trie")]),this._v(" "),e("p",[this._v("The following example shows how to empty, close, and drop a Patricia Trie.")]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{482:function(t,e,i){"use strict";i.r(e);var a=i(37),s=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"empty-close-drop-a-patricia-trie"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#empty-close-drop-a-patricia-trie","aria-hidden":"true"}},[this._v("#")]),this._v(" Empty & Close & Drop a Patricia Trie")]),this._v(" "),e("p",[this._v("The following example shows how to empty, close, and drop a Patricia Trie.")]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/5.273314fb.js b/docs/assets/js/5.d3d64cf4.js similarity index 96% rename from docs/.vuepress/dist/assets/js/5.273314fb.js rename to docs/assets/js/5.d3d64cf4.js index b0de71b3b..bff030e0d 100644 --- a/docs/.vuepress/dist/assets/js/5.273314fb.js +++ b/docs/assets/js/5.d3d64cf4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{373:function(e,t,r){"use strict";r.r(t);var s=r(46),a=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:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[e._v("#")]),e._v(" Contributing")]),e._v(" "),r("h2",{attrs:{id:"what"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#what","aria-hidden":"true"}},[e._v("#")]),e._v(" What?")]),e._v(" "),r("p",[e._v("Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.\nA project is more like an open wiki than a standard guarded open source project.")]),e._v(" "),r("h2",{attrs:{id:"rules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rules","aria-hidden":"true"}},[e._v("#")]),e._v(" Rules")]),e._v(" "),r("p",[e._v("There are a few basic ground-rules for contributors (including the maintainer(s) of the project):")]),e._v(" "),r("p",[e._v(". "),r("strong",[e._v("No "),r("code",[e._v("--force")]),e._v(" pushes")]),e._v(" or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.\n. "),r("strong",[e._v("Non-master branches")]),e._v(", prefixed with a short name moniker (e.g. "),r("code",[e._v("-")]),e._v(") must be used for ongoing work.\n. "),r("strong",[e._v("All modifications")]),e._v(" must be made in a "),r("strong",[e._v("pull-request")]),e._v(" to solicit feedback from other contributors.\n. A pull-request "),r("em",[e._v("must not be merged until CI")]),e._v(" has finished successfully.")]),e._v(" "),r("p",[e._v("Merging pull requests once CI is successful:")]),e._v(" "),r("p",[e._v(". A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.\n. No PR should be merged until all reviews' comments are addressed.")]),e._v(" "),r("p",[e._v(".Reviewing pull requests:\nWhen reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:")]),e._v(" "),r("p",[e._v(". Buggy behaviour.\n. Undue maintenance burden.\n. Breaking with house coding style.\n. Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).\n. Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).\n. Uselessness (i.e. it does not strictly add a feature or fix a known issue).")]),e._v(" "),r("p",[e._v(".Reviews may not be used as an effective veto for a PR because:\n. There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.\n. It does not fit well with some other contributors' longer-term vision for the project.")]),e._v(" "),r("h2",{attrs:{id:"releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#releases","aria-hidden":"true"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),r("p",[e._v("Declaring formal releases remains the prerogative of the project maintainer(s).")]),e._v(" "),r("h2",{attrs:{id:"changes-to-this-arrangement"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#changes-to-this-arrangement","aria-hidden":"true"}},[e._v("#")]),e._v(" Changes to this arrangement")]),e._v(" "),r("p",[e._v("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.")]),e._v(" "),r("h2",{attrs:{id:"heritage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#heritage","aria-hidden":"true"}},[e._v("#")]),e._v(" Heritage")]),e._v(" "),r("p",[e._v('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')])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{356:function(e,t,r){"use strict";r.r(t);var s=r(37),a=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:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[e._v("#")]),e._v(" Contributing")]),e._v(" "),r("h2",{attrs:{id:"what"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#what","aria-hidden":"true"}},[e._v("#")]),e._v(" What?")]),e._v(" "),r("p",[e._v("Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.\nA project is more like an open wiki than a standard guarded open source project.")]),e._v(" "),r("h2",{attrs:{id:"rules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rules","aria-hidden":"true"}},[e._v("#")]),e._v(" Rules")]),e._v(" "),r("p",[e._v("There are a few basic ground-rules for contributors (including the maintainer(s) of the project):")]),e._v(" "),r("p",[e._v(". "),r("strong",[e._v("No "),r("code",[e._v("--force")]),e._v(" pushes")]),e._v(" or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.\n. "),r("strong",[e._v("Non-master branches")]),e._v(", prefixed with a short name moniker (e.g. "),r("code",[e._v("-")]),e._v(") must be used for ongoing work.\n. "),r("strong",[e._v("All modifications")]),e._v(" must be made in a "),r("strong",[e._v("pull-request")]),e._v(" to solicit feedback from other contributors.\n. A pull-request "),r("em",[e._v("must not be merged until CI")]),e._v(" has finished successfully.")]),e._v(" "),r("p",[e._v("Merging pull requests once CI is successful:")]),e._v(" "),r("p",[e._v(". A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.\n. No PR should be merged until all reviews' comments are addressed.")]),e._v(" "),r("p",[e._v(".Reviewing pull requests:\nWhen reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:")]),e._v(" "),r("p",[e._v(". Buggy behaviour.\n. Undue maintenance burden.\n. Breaking with house coding style.\n. Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).\n. Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).\n. Uselessness (i.e. it does not strictly add a feature or fix a known issue).")]),e._v(" "),r("p",[e._v(".Reviews may not be used as an effective veto for a PR because:\n. There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.\n. It does not fit well with some other contributors' longer-term vision for the project.")]),e._v(" "),r("h2",{attrs:{id:"releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#releases","aria-hidden":"true"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),r("p",[e._v("Declaring formal releases remains the prerogative of the project maintainer(s).")]),e._v(" "),r("h2",{attrs:{id:"changes-to-this-arrangement"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#changes-to-this-arrangement","aria-hidden":"true"}},[e._v("#")]),e._v(" Changes to this arrangement")]),e._v(" "),r("p",[e._v("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.")]),e._v(" "),r("h2",{attrs:{id:"heritage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#heritage","aria-hidden":"true"}},[e._v("#")]),e._v(" Heritage")]),e._v(" "),r("p",[e._v('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')])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/50.6038feac.js b/docs/assets/js/50.9cabdd71.js similarity index 92% rename from docs/.vuepress/dist/assets/js/50.6038feac.js rename to docs/assets/js/50.9cabdd71.js index e6c2e8a30..a4ecf5d34 100644 --- a/docs/.vuepress/dist/assets/js/50.6038feac.js +++ b/docs/assets/js/50.9cabdd71.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{505:function(e,t,a){"use strict";a.r(t);var n=a(46),r=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:"trie-db-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#trie-db-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Trie-DB Examples")]),e._v(" "),a("p",[e._v("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.")]),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=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{485:function(e,t,a){"use strict";a.r(t);var n=a(37),r=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:"trie-db-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#trie-db-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Trie-DB Examples")]),e._v(" "),a("p",[e._v("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.")]),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=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/51.5841cdb8.js b/docs/assets/js/51.ba2b125c.js similarity index 84% rename from docs/.vuepress/dist/assets/js/51.5841cdb8.js rename to docs/assets/js/51.ba2b125c.js index c2b67df34..7d8576a0f 100644 --- a/docs/.vuepress/dist/assets/js/51.5841cdb8.js +++ b/docs/assets/js/51.ba2b125c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{508:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"encrypt-decrypt-message-using-nacl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#encrypt-decrypt-message-using-nacl","aria-hidden":"true"}},[this._v("#")]),this._v(" Encrypt & Decrypt Message using NaCl")]),this._v(" "),e("p",[this._v('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.')]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{488:function(t,e,s){"use strict";s.r(e);var a=s(37),r=Object(a.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"encrypt-decrypt-message-using-nacl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#encrypt-decrypt-message-using-nacl","aria-hidden":"true"}},[this._v("#")]),this._v(" Encrypt & Decrypt Message using NaCl")]),this._v(" "),e("p",[this._v('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.')]),this._v(" "),e("p",[e("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/52.07201cd3.js b/docs/assets/js/52.c56f6000.js similarity index 83% rename from docs/.vuepress/dist/assets/js/52.07201cd3.js rename to docs/assets/js/52.c56f6000.js index e9bac836d..42425e4c0 100644 --- a/docs/.vuepress/dist/assets/js/52.07201cd3.js +++ b/docs/assets/js/52.c56f6000.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{316:function(s,t,e){"use strict";e.r(t);var i=e(37),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/53.95738ad9.js b/docs/assets/js/53.12e0e763.js similarity index 82% rename from docs/.vuepress/dist/assets/js/53.95738ad9.js rename to docs/assets/js/53.12e0e763.js index 244224ad8..4fd79d547 100644 --- a/docs/.vuepress/dist/assets/js/53.95738ad9.js +++ b/docs/assets/js/53.12e0e763.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{456:function(e,t,n){"use strict";n.r(t);var s=n(46),i=Object(s.a)({},function(){var e=this.$createElement,t=this._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"create-generate-mnemonic-using-bip39"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-generate-mnemonic-using-bip39","aria-hidden":"true"}},[this._v("#")]),this._v(" Create & Generate Mnemonic using BIP39")]),this._v(" "),t("p",[this._v("The following example shows how to create and generate mnemonics using BIP39.")]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{436:function(e,t,n){"use strict";n.r(t);var s=n(37),i=Object(s.a)({},function(){var e=this.$createElement,t=this._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"create-generate-mnemonic-using-bip39"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-generate-mnemonic-using-bip39","aria-hidden":"true"}},[this._v("#")]),this._v(" Create & Generate Mnemonic using BIP39")]),this._v(" "),t("p",[this._v("The following example shows how to create and generate mnemonics using BIP39.")]),this._v(" "),t("p",[t("a",{attrs:{href:"index.js"}},[this._v("include")])])])},[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/54.36b1fbcd.js b/docs/assets/js/54.8fa7bf18.js similarity index 90% rename from docs/.vuepress/dist/assets/js/54.36b1fbcd.js rename to docs/assets/js/54.8fa7bf18.js index f84d41f43..9e2bb031a 100644 --- a/docs/.vuepress/dist/assets/js/54.36b1fbcd.js +++ b/docs/assets/js/54.8fa7bf18.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{439:function(e,t,a){"use strict";a.r(t);var n=a(37),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/55.210cf109.js b/docs/assets/js/55.18950e15.js similarity index 93% rename from docs/.vuepress/dist/assets/js/55.210cf109.js rename to docs/assets/js/55.18950e15.js index 4076203a4..d803032d7 100644 --- a/docs/.vuepress/dist/assets/js/55.210cf109.js +++ b/docs/assets/js/55.18950e15.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{511: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:"polkadot-keyring"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-keyring","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/keyring")]),t._v(" "),e("p",[t._v("Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.")]),t._v(" "),e("h2",{attrs:{id:"usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),e("p",[t._v("Installation -")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("yarn add @polkadot/keyring\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Classes and Functions can be imported as follows:")]),t._v(" "),e("div",{staticClass:"language-js line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Keyring "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),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("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/keyring/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([[55],{491:function(t,a,e){"use strict";e.r(a);var s=e(37),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:"polkadot-keyring"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-keyring","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/keyring")]),t._v(" "),e("p",[t._v("Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.")]),t._v(" "),e("h2",{attrs:{id:"usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),e("p",[t._v("Installation -")]),t._v(" "),e("div",{staticClass:"language- line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("yarn add @polkadot/keyring\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("Classes and Functions can be imported as follows:")]),t._v(" "),e("div",{staticClass:"language-js line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Keyring "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),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("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/keyring/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/56.b9456f9c.js b/docs/assets/js/56.0d82d79a.js similarity index 94% rename from docs/.vuepress/dist/assets/js/56.b9456f9c.js rename to docs/assets/js/56.0d82d79a.js index 86e0ea586..bb494f641 100644 --- a/docs/.vuepress/dist/assets/js/56.b9456f9c.js +++ b/docs/assets/js/56.0d82d79a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{514:function(t,r,e){"use strict";e.r(r);var s=e(46),i=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("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_decode_.html"}},[t._v('"address/decode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_defaults_.html"}},[t._v('"address/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_encode_.html"}},[t._v('"address/encode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_setprefix_.html"}},[t._v('"address/setPrefix"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_types_.html"}},[t._v('"address/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_decode_.html"}},[t._v('"pair/decode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_defaults_.html"}},[t._v('"pair/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_encode_.html"}},[t._v('"pair/encode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_nobody_.html"}},[t._v('"pair/nobody"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_tojson_.html"}},[t._v('"pair/toJson"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_types_.html"}},[t._v('"pair/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pairs_.html"}},[t._v('"pairs"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_testing_.html"}},[t._v('"testing"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_testingpairs_.html"}},[t._v('"testingPairs"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[t._v("KeyringPairs")])],1)])],1)])])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{494:function(t,r,e){"use strict";e.r(r);var s=e(37),i=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("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_decode_.html"}},[t._v('"address/decode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_defaults_.html"}},[t._v('"address/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_encode_.html"}},[t._v('"address/encode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_setprefix_.html"}},[t._v('"address/setPrefix"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_address_types_.html"}},[t._v('"address/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_decode_.html"}},[t._v('"pair/decode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_defaults_.html"}},[t._v('"pair/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_encode_.html"}},[t._v('"pair/encode"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_nobody_.html"}},[t._v('"pair/nobody"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_tojson_.html"}},[t._v('"pair/toJson"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pair_types_.html"}},[t._v('"pair/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_pairs_.html"}},[t._v('"pairs"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_testing_.html"}},[t._v('"testing"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_testingpairs_.html"}},[t._v('"testingPairs"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringinstance.html"}},[t._v("KeyringInstance")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpair.html"}},[t._v("KeyringPair")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/keyring/interfaces/_types_.keyringpairs.html"}},[t._v("KeyringPairs")])],1)])],1)])])},[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/57.541a883c.js b/docs/assets/js/57.72a1117a.js similarity index 91% rename from docs/.vuepress/dist/assets/js/57.541a883c.js rename to docs/assets/js/57.72a1117a.js index 4e54f5f7d..8b75fbfd9 100644 --- a/docs/.vuepress/dist/assets/js/57.541a883c.js +++ b/docs/assets/js/57.72a1117a.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{497:function(r,t,e){"use strict";e.r(t);var a=e(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.434d2ad0.js b/docs/assets/js/58.70ff145a.js similarity index 93% rename from docs/.vuepress/dist/assets/js/58.434d2ad0.js rename to docs/assets/js/58.70ff145a.js index bf34c849a..8ff43e12a 100644 --- a/docs/.vuepress/dist/assets/js/58.434d2ad0.js +++ b/docs/assets/js/58.70ff145a.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{503:function(r,e,t){"use strict";t.r(e);var a=t(37),_=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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.dc6dac5c.js b/docs/assets/js/59.ab716bfd.js similarity index 93% rename from docs/.vuepress/dist/assets/js/59.dc6dac5c.js rename to docs/assets/js/59.ab716bfd.js index 44076cec8..685360e0f 100644 --- a/docs/.vuepress/dist/assets/js/59.dc6dac5c.js +++ b/docs/assets/js/59.ab716bfd.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{500:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6.4211a0b3.js b/docs/assets/js/6.f21429bb.js similarity index 96% rename from docs/.vuepress/dist/assets/js/6.4211a0b3.js rename to docs/assets/js/6.f21429bb.js index b051d5c65..e79a58ef5 100644 --- a/docs/.vuepress/dist/assets/js/6.4211a0b3.js +++ b/docs/assets/js/6.f21429bb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[6],{376:function(t,e,r){"use strict";r.r(e);var o=r(46),a=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:"polkadot-javascript-common"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-javascript-common","aria-hidden":"true"}},[t._v("#")]),t._v(" Polkadot Javascript Common")]),t._v(" "),r("p",[t._v("Various useful utility functions that are used across all projects in the "),r("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("@polkadot"),r("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(" "),r("p",[t._v("It is split up into a number of internal packages, namely utilities -")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/keyring/"}},[t._v("keyring")]),t._v(" Keyring management")],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util/"}},[t._v("util")]),t._v(" General utilities")],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/"}},[t._v("util-crypto")]),t._v(" Crypto and hashing utilities")],1)]),t._v(" "),r("h2",{attrs:{id:"the-polkadot-project"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#the-polkadot-project","aria-hidden":"true"}},[t._v("#")]),t._v(" The Polkadot Project")]),t._v(" "),r("p",[t._v("You can read more about the Polkadot Network at "),r("a",{attrs:{href:"https://polkadot.network/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.network/"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"github-repositories"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#github-repositories","aria-hidden":"true"}},[t._v("#")]),t._v(" Github repositories")]),t._v(" "),r("p",[t._v("You can find the Polkadot repositories at:")]),t._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/polkadot-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js"),r("OutboundLink")],1)]),t._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/paritytech/polkadot",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/polkadot"),r("OutboundLink")],1)]),t._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/paritytech/substrate",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/substrate"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("This documentation is generated from "),r("a",{attrs:{href:"https://github.com/polkadot-js/common",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js/common"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[t._v("#")]),t._v(" Contributing")]),t._v(" "),r("p",[t._v("Contribution to Polkadot JS Common are more than welcome. You can "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("report issues"),r("OutboundLink")],1),t._v(" and "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("log feature requests"),r("OutboundLink")],1),t._v(".")])])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[6],{353:function(t,e,r){"use strict";r.r(e);var o=r(37),a=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:"polkadot-javascript-common"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-javascript-common","aria-hidden":"true"}},[t._v("#")]),t._v(" Polkadot Javascript Common")]),t._v(" "),r("p",[t._v("Various useful utility functions that are used across all projects in the "),r("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("@polkadot"),r("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(" "),r("p",[t._v("It is split up into a number of internal packages, namely utilities -")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/keyring/"}},[t._v("keyring")]),t._v(" Keyring management")],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util/"}},[t._v("util")]),t._v(" General utilities")],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/util-crypto/"}},[t._v("util-crypto")]),t._v(" Crypto and hashing utilities")],1)]),t._v(" "),r("h2",{attrs:{id:"the-polkadot-project"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#the-polkadot-project","aria-hidden":"true"}},[t._v("#")]),t._v(" The Polkadot Project")]),t._v(" "),r("p",[t._v("You can read more about the Polkadot Network at "),r("a",{attrs:{href:"https://polkadot.network/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.network/"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"github-repositories"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#github-repositories","aria-hidden":"true"}},[t._v("#")]),t._v(" Github repositories")]),t._v(" "),r("p",[t._v("You can find the Polkadot repositories at:")]),t._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/polkadot-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js"),r("OutboundLink")],1)]),t._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/paritytech/polkadot",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/polkadot"),r("OutboundLink")],1)]),t._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/paritytech/substrate",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/substrate"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("This documentation is generated from "),r("a",{attrs:{href:"https://github.com/polkadot-js/common",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js/common"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[t._v("#")]),t._v(" Contributing")]),t._v(" "),r("p",[t._v("Contribution to Polkadot JS Common are more than welcome. You can "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("report issues"),r("OutboundLink")],1),t._v(" and "),r("a",{attrs:{href:"https://github.com/polkadot-js/common/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("log feature requests"),r("OutboundLink")],1),t._v(".")])])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/60.e830d4c9.js b/docs/assets/js/60.bb203df0.js similarity index 93% rename from docs/.vuepress/dist/assets/js/60.e830d4c9.js rename to docs/assets/js/60.bb203df0.js index 38f59f0d3..e04c970d0 100644 --- a/docs/.vuepress/dist/assets/js/60.e830d4c9.js +++ b/docs/assets/js/60.bb203df0.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{506:function(t,r,e){"use strict";e.r(r);var a=e(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.a5c6d657.js b/docs/assets/js/61.2d3cad63.js similarity index 90% rename from docs/.vuepress/dist/assets/js/61.a5c6d657.js rename to docs/assets/js/61.2d3cad63.js index 08e6edaf2..48b487664 100644 --- a/docs/.vuepress/dist/assets/js/61.a5c6d657.js +++ b/docs/assets/js/61.2d3cad63.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{509:function(e,t,r){"use strict";r.r(t);var d=r(37),_=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/6506c10/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/62.e1a3e089.js b/docs/assets/js/62.da1de15f.js similarity index 58% rename from docs/.vuepress/dist/assets/js/62.e1a3e089.js rename to docs/assets/js/62.da1de15f.js index 9cb2ae5cd..249e30558 100644 --- a/docs/.vuepress/dist/assets/js/62.e1a3e089.js +++ b/docs/assets/js/62.da1de15f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{532: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([[62],{512:function(t,e,n){"use strict";n.r(e);var s=n(37),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/63.44b784a4.js b/docs/assets/js/63.dcf1f39e.js similarity index 90% rename from docs/.vuepress/dist/assets/js/63.44b784a4.js rename to docs/assets/js/63.dcf1f39e.js index 49d2e1e24..5a006a4f6 100644 --- a/docs/.vuepress/dist/assets/js/63.44b784a4.js +++ b/docs/assets/js/63.dcf1f39e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{515:function(e,t,r){"use strict";r.r(t);var _=r(37),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/6506c10/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.0b302571.js b/docs/assets/js/64.17b8c833.js similarity index 87% rename from docs/.vuepress/dist/assets/js/64.0b302571.js rename to docs/assets/js/64.17b8c833.js index e9d3ac647..a41e6298c 100644 --- a/docs/.vuepress/dist/assets/js/64.0b302571.js +++ b/docs/assets/js/64.17b8c833.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{518:function(t,e,r){"use strict";r.r(e);var s=r(37),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/6506c10/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.c59be25f.js b/docs/assets/js/65.e64cbfd1.js similarity index 84% rename from docs/.vuepress/dist/assets/js/65.c59be25f.js rename to docs/assets/js/65.e64cbfd1.js index fb05a1074..10a6478b6 100644 --- a/docs/.vuepress/dist/assets/js/65.c59be25f.js +++ b/docs/assets/js/65.e64cbfd1.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{517:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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.d89c854d.js b/docs/assets/js/66.dea91536.js similarity index 89% rename from docs/.vuepress/dist/assets/js/66.d89c854d.js rename to docs/assets/js/66.dea91536.js index 71f538c0d..afc4fbc02 100644 --- a/docs/.vuepress/dist/assets/js/66.d89c854d.js +++ b/docs/assets/js/66.dea91536.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{516:function(e,t,r){"use strict";r.r(t);var d=r(37),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/6506c10/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/67.f1ea78fd.js b/docs/assets/js/67.3e2303e6.js similarity index 58% rename from docs/.vuepress/dist/assets/js/67.f1ea78fd.js rename to docs/assets/js/67.3e2303e6.js index 5d2cadea2..4ad27826e 100644 --- a/docs/.vuepress/dist/assets/js/67.f1ea78fd.js +++ b/docs/assets/js/67.3e2303e6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{534: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([[67],{514:function(t,e,n){"use strict";n.r(e);var s=n(37),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/68.cc747b6b.js b/docs/assets/js/68.4b760478.js similarity index 88% rename from docs/.vuepress/dist/assets/js/68.cc747b6b.js rename to docs/assets/js/68.4b760478.js index bf6004fc9..9e9ecf4e7 100644 --- a/docs/.vuepress/dist/assets/js/68.cc747b6b.js +++ b/docs/assets/js/68.4b760478.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{513:function(e,t,r){"use strict";r.r(t);var n=r(37),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/6506c10/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.a0aca143.js b/docs/assets/js/69.aae2c258.js similarity index 85% rename from docs/.vuepress/dist/assets/js/69.a0aca143.js rename to docs/assets/js/69.aae2c258.js index ed16899fe..be6f03109 100644 --- a/docs/.vuepress/dist/assets/js/69.a0aca143.js +++ b/docs/assets/js/69.aae2c258.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{511:function(t,r,e){"use strict";e.r(r);var n=e(37),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/6506c10/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/7.9cff3c08.js b/docs/assets/js/7.ca73c292.js similarity index 83% rename from docs/.vuepress/dist/assets/js/7.9cff3c08.js rename to docs/assets/js/7.ca73c292.js index 2749f7d9e..7c5717e41 100644 --- a/docs/.vuepress/dist/assets/js/7.9cff3c08.js +++ b/docs/assets/js/7.ca73c292.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[7],{379:function(t,a,e){"use strict";e.r(a);var i=e(46),s=Object(i.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:"polkadot-chainspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-chainspec","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/chainspec")]),t._v(" "),e("p",[t._v("Chainspecs for known chains")]),t._v(" "),e("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/chainspec/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[7],{359:function(t,a,e){"use strict";e.r(a);var i=e(37),s=Object(i.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:"polkadot-chainspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-chainspec","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/chainspec")]),t._v(" "),e("p",[t._v("Chainspecs for known chains")]),t._v(" "),e("h2",{attrs:{id:"utilities"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/chainspec/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/70.6aa525bb.js b/docs/assets/js/70.ce5ac9f4.js similarity index 91% rename from docs/.vuepress/dist/assets/js/70.6aa525bb.js rename to docs/assets/js/70.ce5ac9f4.js index b01865e02..0b4279da8 100644 --- a/docs/.vuepress/dist/assets/js/70.6aa525bb.js +++ b/docs/assets/js/70.ce5ac9f4.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{510:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.83d894e0.js b/docs/assets/js/71.b8617a74.js similarity index 84% rename from docs/.vuepress/dist/assets/js/71.83d894e0.js rename to docs/assets/js/71.b8617a74.js index aa64ee164..13941e749 100644 --- a/docs/.vuepress/dist/assets/js/71.83d894e0.js +++ b/docs/assets/js/71.b8617a74.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{508:function(t,a,e){"use strict";e.r(a);var r=e(37),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/6506c10/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/72.2b075c81.js b/docs/assets/js/72.19e4eeec.js similarity index 82% rename from docs/.vuepress/dist/assets/js/72.2b075c81.js rename to docs/assets/js/72.19e4eeec.js index 137058076..fd0da3745 100644 --- a/docs/.vuepress/dist/assets/js/72.2b075c81.js +++ b/docs/assets/js/72.19e4eeec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[72],{527: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:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[72],{507:function(t,s,a){"use strict";a.r(s);var e=a(37),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:"/keyring/classes/_pairs_.pairs.html"}},[t._v("Pairs")])],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/73.89cc551f.js b/docs/assets/js/73.8a6b2174.js similarity index 91% rename from docs/.vuepress/dist/assets/js/73.89cc551f.js rename to docs/assets/js/73.8a6b2174.js index 2b0ca8212..3311d38f3 100644 --- a/docs/.vuepress/dist/assets/js/73.89cc551f.js +++ b/docs/assets/js/73.8a6b2174.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{504:function(t,e,n){"use strict";n.r(e);var r=n(37),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/6506c10/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.0d118f78.js b/docs/assets/js/74.efbd4c7e.js similarity index 88% rename from docs/.vuepress/dist/assets/js/74.0d118f78.js rename to docs/assets/js/74.efbd4c7e.js index 3569cbca2..94db81b3a 100644 --- a/docs/.vuepress/dist/assets/js/74.0d118f78.js +++ b/docs/assets/js/74.efbd4c7e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{505:function(t,e,r){"use strict";r.r(e);var s=r(37),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/6506c10/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.11553212.js b/docs/assets/js/75.d0f212cc.js similarity index 91% rename from docs/.vuepress/dist/assets/js/75.11553212.js rename to docs/assets/js/75.d0f212cc.js index 296c4c983..3dbb227df 100644 --- a/docs/.vuepress/dist/assets/js/75.11553212.js +++ b/docs/assets/js/75.d0f212cc.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{502:function(e,r,t){"use strict";t.r(r);var a=t(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/76.5786ef1a.js b/docs/assets/js/76.7fac27d7.js similarity index 84% rename from docs/.vuepress/dist/assets/js/76.5786ef1a.js rename to docs/assets/js/76.7fac27d7.js index 633ff8eef..2c5392186 100644 --- a/docs/.vuepress/dist/assets/js/76.5786ef1a.js +++ b/docs/assets/js/76.7fac27d7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[76],{521:function(t,e,i){"use strict";i.r(e);var r=i(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,i=t._self._c||e;return i("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[i("h1",{attrs:{id:"polkadot-trie-codec"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-codec")]),t._v(" "),i("p",[t._v("Implementation of the Substrate-specific codec for a Trie")]),t._v(" "),i("h2",{attrs:{id:"utilities"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),i("p",[i("router-link",{attrs:{to:"/trie-codec/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[76],{501:function(t,e,i){"use strict";i.r(e);var r=i(37),a=Object(r.a)({},function(){var t=this,e=t.$createElement,i=t._self._c||e;return i("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[i("h1",{attrs:{id:"polkadot-trie-codec"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-trie-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/trie-codec")]),t._v(" "),i("p",[t._v("Implementation of the Substrate-specific codec for a Trie")]),t._v(" "),i("h2",{attrs:{id:"utilities"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#utilities","aria-hidden":"true"}},[t._v("#")]),t._v(" Utilities")]),t._v(" "),i("p",[i("router-link",{attrs:{to:"/trie-codec/SUMMARY.html"}},[t._v("Utilities")])],1)])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/77.80b74117.js b/docs/assets/js/77.e6af7b98.js similarity index 96% rename from docs/.vuepress/dist/assets/js/77.80b74117.js rename to docs/assets/js/77.e6af7b98.js index fdd953d6e..a02a9926d 100644 --- a/docs/.vuepress/dist/assets/js/77.80b74117.js +++ b/docs/assets/js/77.e6af7b98.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[77],{519:function(e,t,r){"use strict";r.r(t);var l=r(46),o=Object(l.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_nodeheader_.html"}},[e._v('"NodeHeader"')]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")])],1)])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_constants_.html"}},[e._v('"constants"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_decode_.html"}},[e._v('"decode"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_encode_.html"}},[e._v('"encode"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_hashing_.html"}},[e._v('"hashing"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_nibbles_.html"}},[e._v('"nibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createbranch_.html"}},[e._v('"stream/createBranch"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createempty_.html"}},[e._v('"stream/createEmpty"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createextension_.html"}},[e._v('"stream/createExtension"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createleaf_.html"}},[e._v('"stream/createLeaf"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createsubstream_.html"}},[e._v('"stream/createSubstream"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createvalue_.html"}},[e._v('"stream/createValue"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_endbranch_.html"}},[e._v('"stream/endBranch"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_types_.html"}},[e._v('"types"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_fromnibbles_.html"}},[e._v('"util/fromNibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_fusenibbles_.html"}},[e._v('"util/fuseNibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_sharedprefixlength_.html"}},[e._v('"util/sharedPrefixLength"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_tonibbles_.html"}},[e._v('"util/toNibbles"')])],1)])])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[77],{499:function(e,t,r){"use strict";r.r(t);var l=r(37),o=Object(l.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_nodeheader_.html"}},[e._v('"NodeHeader"')]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")])],1)])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_constants_.html"}},[e._v('"constants"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_decode_.html"}},[e._v('"decode"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_encode_.html"}},[e._v('"encode"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_hashing_.html"}},[e._v('"hashing"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_nibbles_.html"}},[e._v('"nibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createbranch_.html"}},[e._v('"stream/createBranch"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createempty_.html"}},[e._v('"stream/createEmpty"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createextension_.html"}},[e._v('"stream/createExtension"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createleaf_.html"}},[e._v('"stream/createLeaf"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createsubstream_.html"}},[e._v('"stream/createSubstream"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_createvalue_.html"}},[e._v('"stream/createValue"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_stream_endbranch_.html"}},[e._v('"stream/endBranch"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_types_.html"}},[e._v('"types"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_fromnibbles_.html"}},[e._v('"util/fromNibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_fusenibbles_.html"}},[e._v('"util/fuseNibbles"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_sharedprefixlength_.html"}},[e._v('"util/sharedPrefixLength"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/modules/_util_tonibbles_.html"}},[e._v('"util/toNibbles"')])],1)])])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/78.ca222a4d.js b/docs/assets/js/78.69d0f899.js similarity index 93% rename from docs/.vuepress/dist/assets/js/78.ca222a4d.js rename to docs/assets/js/78.69d0f899.js index 1b3e6761b..f338d10ee 100644 --- a/docs/.vuepress/dist/assets/js/78.ca222a4d.js +++ b/docs/assets/js/78.69d0f899.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[78],{518:function(e,t,a){"use strict";a.r(t);var r=a(46),o=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:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),a("p",[a("code",[e._v("Boolean")])]),e._v(" "),a("p",[a("strong",[e._v("↳ BranchHeader")])]),e._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),a("p",[a("a",{attrs:{id:"boolean"}})]),e._v(" "),a("h2",{attrs:{id:"static-boolean"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-boolean","aria-hidden":"true"}},[e._v("#")]),e._v(" "),a("code",[e._v("")]),e._v(" Boolean")]),e._v(" "),a("p",[a("strong",[e._v("● Boolean")]),e._v(": "),a("em",[a("code",[e._v("BooleanConstructor")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540")])]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),a("p",[a("a",{attrs:{id:"valueof"}})]),e._v(" "),a("h2",{attrs:{id:"valueof"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#valueof","aria-hidden":"true"}},[e._v("#")]),e._v(" valueOf")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("valueOf")]),e._v("(): "),a("code",[e._v("boolean")])]),e._v(" "),a("p",[a("em",[e._v("Inherited from Boolean.valueOf")])]),e._v(" "),a("p",[a("em",[e._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531")])]),e._v(" "),a("p",[e._v("Returns the primitive value of the specified object.")]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("boolean")])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[78],{498:function(e,t,a){"use strict";a.r(t);var r=a(37),o=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:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),a("p",[a("code",[e._v("Boolean")])]),e._v(" "),a("p",[a("strong",[e._v("↳ BranchHeader")])]),e._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),a("p",[a("a",{attrs:{id:"boolean"}})]),e._v(" "),a("h2",{attrs:{id:"static-boolean"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-boolean","aria-hidden":"true"}},[e._v("#")]),e._v(" "),a("code",[e._v("")]),e._v(" Boolean")]),e._v(" "),a("p",[a("strong",[e._v("● Boolean")]),e._v(": "),a("em",[a("code",[e._v("BooleanConstructor")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:540")])]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),a("p",[a("a",{attrs:{id:"valueof"}})]),e._v(" "),a("h2",{attrs:{id:"valueof"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#valueof","aria-hidden":"true"}},[e._v("#")]),e._v(" valueOf")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("valueOf")]),e._v("(): "),a("code",[e._v("boolean")])]),e._v(" "),a("p",[a("em",[e._v("Inherited from Boolean.valueOf")])]),e._v(" "),a("p",[a("em",[e._v("Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:531")])]),e._v(" "),a("p",[e._v("Returns the primitive value of the specified object.")]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("boolean")])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/79.71ce2c6c.js b/docs/assets/js/79.beb6db07.js similarity index 92% rename from docs/.vuepress/dist/assets/js/79.71ce2c6c.js rename to docs/assets/js/79.beb6db07.js index d192e93eb..3a476644f 100644 --- a/docs/.vuepress/dist/assets/js/79.71ce2c6c.js +++ b/docs/assets/js/79.beb6db07.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{496:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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/6506c10/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/8.ee3a3ff3.js b/docs/assets/js/8.f41603fc.js similarity index 80% rename from docs/.vuepress/dist/assets/js/8.ee3a3ff3.js rename to docs/assets/js/8.f41603fc.js index ed6e6d858..db05ca0ca 100644 --- a/docs/.vuepress/dist/assets/js/8.ee3a3ff3.js +++ b/docs/assets/js/8.f41603fc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{382:function(t,e,s){"use strict";s.r(e);var l=s(46),i=Object(l.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_bbqbirch_.html"}},[this._v('"bbqbirch"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_krummelanke_.html"}},[this._v('"krummelanke"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_types_.html"}},[this._v('"types"')])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{362:function(t,e,s){"use strict";s.r(e);var l=s(37),i=Object(l.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_bbqbirch_.html"}},[this._v('"bbqbirch"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_krummelanke_.html"}},[this._v('"krummelanke"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/chainspec/modules/_types_.html"}},[this._v('"types"')])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/.vuepress/dist/assets/js/80.c2f44ca3.js b/docs/assets/js/80.1640a68b.js similarity index 92% rename from docs/.vuepress/dist/assets/js/80.c2f44ca3.js rename to docs/assets/js/80.1640a68b.js index 8421a30e5..68f636ef8 100644 --- a/docs/.vuepress/dist/assets/js/80.c2f44ca3.js +++ b/docs/assets/js/80.1640a68b.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[80],{495:function(e,r,t){"use strict";t.r(r);var a=t(37),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/6506c10/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/6506c10/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.8a7a630b.js b/docs/assets/js/81.642b5781.js similarity index 91% rename from docs/.vuepress/dist/assets/js/81.8a7a630b.js rename to docs/assets/js/81.642b5781.js index e0dfe2f09..316f36921 100644 --- a/docs/.vuepress/dist/assets/js/81.8a7a630b.js +++ b/docs/assets/js/81.642b5781.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[81],{493:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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/6506c10/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.63a91c1f.js b/docs/assets/js/82.8ad7086a.js similarity index 92% rename from docs/.vuepress/dist/assets/js/82.63a91c1f.js rename to docs/assets/js/82.8ad7086a.js index 24299916b..4bf1e1cab 100644 --- a/docs/.vuepress/dist/assets/js/82.63a91c1f.js +++ b/docs/assets/js/82.8ad7086a.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{492:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.ce3a21bb.js b/docs/assets/js/83.1c830a49.js similarity index 75% rename from docs/.vuepress/dist/assets/js/83.ce3a21bb.js rename to docs/assets/js/83.1c830a49.js index 881e37e37..456492840 100644 --- a/docs/.vuepress/dist/assets/js/83.ce3a21bb.js +++ b/docs/assets/js/83.1c830a49.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{490:function(t,r,s){"use strict";s.r(r);var e=s(37),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.30cc8514.js b/docs/assets/js/84.c310d4db.js similarity index 88% rename from docs/.vuepress/dist/assets/js/84.30cc8514.js rename to docs/assets/js/84.c310d4db.js index 97a4c75c6..54cf3af83 100644 --- a/docs/.vuepress/dist/assets/js/84.30cc8514.js +++ b/docs/assets/js/84.c310d4db.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{489:function(t,e,n){"use strict";n.r(e);var o=n(37),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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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.d1539fa0.js b/docs/assets/js/85.59dea405.js similarity index 90% rename from docs/.vuepress/dist/assets/js/85.d1539fa0.js rename to docs/assets/js/85.59dea405.js index 4cde3a64b..fc19660e0 100644 --- a/docs/.vuepress/dist/assets/js/85.d1539fa0.js +++ b/docs/assets/js/85.59dea405.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{487:function(e,t,r){"use strict";r.r(t);var _=r(37),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/6506c10/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.bf1809e4.js b/docs/assets/js/86.161c2e9e.js similarity index 89% rename from docs/.vuepress/dist/assets/js/86.bf1809e4.js rename to docs/assets/js/86.161c2e9e.js index 641b8aa35..95d96bff8 100644 --- a/docs/.vuepress/dist/assets/js/86.bf1809e4.js +++ b/docs/assets/js/86.161c2e9e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[86],{486:function(e,t,r){"use strict";r.r(t);var n=r(37),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/6506c10/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/87.7e785c8c.js b/docs/assets/js/87.7e785c8c.js new file mode 100644 index 000000000..d71522523 --- /dev/null +++ b/docs/assets/js/87.7e785c8c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[87],{484:function(t,e,n){"use strict";n.r(e);var s=n(37),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/88.de0b3335.js b/docs/assets/js/88.872b8712.js similarity index 92% rename from docs/.vuepress/dist/assets/js/88.de0b3335.js rename to docs/assets/js/88.872b8712.js index b06a9c58b..d1cda6580 100644 --- a/docs/.vuepress/dist/assets/js/88.de0b3335.js +++ b/docs/assets/js/88.872b8712.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[88],{481:function(e,t,r){"use strict";r.r(t);var a=r(37),_=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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/6506c10/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/89.a73fda23.js b/docs/assets/js/89.c51ac1a9.js similarity index 90% rename from docs/.vuepress/dist/assets/js/89.a73fda23.js rename to docs/assets/js/89.c51ac1a9.js index cac11d1c9..c30b148ed 100644 --- a/docs/.vuepress/dist/assets/js/89.a73fda23.js +++ b/docs/assets/js/89.c51ac1a9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[89],{501: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:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")])],1)]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[89],{483:function(e,t,r){"use strict";r.r(t);var a=r(37),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:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.branchheader.html"}},[e._v("BranchHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.extensionheader.html"}},[e._v("ExtensionHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.leafheader.html"}},[e._v("LeafHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nibbleheader.html"}},[e._v("NibbleHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.nodeheader.html"}},[e._v("NodeHeader")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/trie-codec/classes/_nodeheader_.null.html"}},[e._v("Null")])],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/9.8b5d10b6.js b/docs/assets/js/9.0ed9bc1c.js similarity index 57% rename from docs/.vuepress/dist/assets/js/9.8b5d10b6.js rename to docs/assets/js/9.0ed9bc1c.js index 508ef9c0f..74b397f52 100644 --- a/docs/.vuepress/dist/assets/js/9.8b5d10b6.js +++ b/docs/assets/js/9.0ed9bc1c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{385: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([[9],{365:function(t,e,n){"use strict";n.r(e);var s=n(37),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/90.fc751a64.js b/docs/assets/js/90.72b01137.js similarity index 89% rename from docs/.vuepress/dist/assets/js/90.fc751a64.js rename to docs/assets/js/90.72b01137.js index 021be2364..59a456fdc 100644 --- a/docs/.vuepress/dist/assets/js/90.fc751a64.js +++ b/docs/assets/js/90.72b01137.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{480:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.9a0c0b54.js b/docs/assets/js/91.ed7a7fd2.js similarity index 83% rename from docs/.vuepress/dist/assets/js/91.9a0c0b54.js rename to docs/assets/js/91.ed7a7fd2.js index 02297661e..414c46b21 100644 --- a/docs/.vuepress/dist/assets/js/91.9a0c0b54.js +++ b/docs/assets/js/91.ed7a7fd2.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[91],{478:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.f45b658c.js b/docs/assets/js/92.be49de48.js similarity index 87% rename from docs/.vuepress/dist/assets/js/92.f45b658c.js rename to docs/assets/js/92.be49de48.js index 0d25e574f..fa99d428a 100644 --- a/docs/.vuepress/dist/assets/js/92.f45b658c.js +++ b/docs/assets/js/92.be49de48.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[92],{477:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.4228fc8d.js b/docs/assets/js/93.bd253e6a.js similarity index 84% rename from docs/.vuepress/dist/assets/js/93.4228fc8d.js rename to docs/assets/js/93.bd253e6a.js index 431bac1d2..3cbb9f3d9 100644 --- a/docs/.vuepress/dist/assets/js/93.4228fc8d.js +++ b/docs/assets/js/93.bd253e6a.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[93],{475:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.6d5a907e.js b/docs/assets/js/94.7dd60e3e.js similarity index 87% rename from docs/.vuepress/dist/assets/js/94.6d5a907e.js rename to docs/assets/js/94.7dd60e3e.js index 1f1cdb3fd..a64edb6b1 100644 --- a/docs/.vuepress/dist/assets/js/94.6d5a907e.js +++ b/docs/assets/js/94.7dd60e3e.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[94],{474:function(t,e,r){"use strict";r.r(e);var a=r(37),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/6506c10/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.8c661080.js b/docs/assets/js/95.5dc9a54b.js similarity index 87% rename from docs/.vuepress/dist/assets/js/95.8c661080.js rename to docs/assets/js/95.5dc9a54b.js index 65359b19f..2c791b130 100644 --- a/docs/.vuepress/dist/assets/js/95.8c661080.js +++ b/docs/assets/js/95.5dc9a54b.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[95],{471:function(e,t,r){"use strict";r.r(t);var a=r(37),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/6506c10/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.be58a66c.js b/docs/assets/js/96.65e13a38.js similarity index 87% rename from docs/.vuepress/dist/assets/js/96.be58a66c.js rename to docs/assets/js/96.65e13a38.js index 6ae63de34..865b4515b 100644 --- a/docs/.vuepress/dist/assets/js/96.be58a66c.js +++ b/docs/assets/js/96.65e13a38.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[96],{472:function(t,e,r){"use strict";r.r(e);var n=r(37),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/6506c10/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.7606a016.js b/docs/assets/js/97.f46579ba.js similarity index 84% rename from docs/.vuepress/dist/assets/js/97.7606a016.js rename to docs/assets/js/97.f46579ba.js index b147d6b0e..3c282cbf5 100644 --- a/docs/.vuepress/dist/assets/js/97.7606a016.js +++ b/docs/assets/js/97.f46579ba.js @@ -1 +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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{469:function(e,t,a){"use strict";a.r(t);var r=a(37),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/6506c10/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.a559845e.js b/docs/assets/js/98.f18656f8.js similarity index 95% rename from docs/.vuepress/dist/assets/js/98.a559845e.js rename to docs/assets/js/98.f18656f8.js index 7e7bde2df..c68c0f7c1 100644 --- a/docs/.vuepress/dist/assets/js/98.a559845e.js +++ b/docs/assets/js/98.f18656f8.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{468:function(t,s,a){"use strict";a.r(s);var n=a(37),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/6506c10/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.c6bdd4ab.js b/docs/assets/js/99.69c06054.js similarity index 88% rename from docs/.vuepress/dist/assets/js/99.c6bdd4ab.js rename to docs/assets/js/99.69c06054.js index 61242c947..0e8c2b431 100644 --- a/docs/.vuepress/dist/assets/js/99.c6bdd4ab.js +++ b/docs/assets/js/99.69c06054.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/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{466:function(e,t,s){"use strict";s.r(t);var r=s(37),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/6506c10/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.18194d4f.js b/docs/assets/js/app.18194d4f.js new file mode 100644 index 000000000..92dd58e0e --- /dev/null +++ b/docs/assets/js/app.18194d4f.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){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(98),o=n(74);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(172)(!0);n(81)(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(5).f,o=n(16),a=n(3)("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(9),o=n(108),a=n(109),i=n(7),l=n(46),s=n(110),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(162)},function(e,t,n){e.exports=n(166)},function(e,t,n){e.exports=n(190)},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){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t,n){var r=n(22),o=n(129),a=n(130),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){"use strict";var r=n(38);e.exports=function(e,t){return!!e&&r(function(){t?e.call(null,function(){},1):e.call(null)})}},function(e,t,n){var r=n(13),o=n(15),a=n(42),i=n(65)("src"),l=n(139),s=(""+l).split("toString");n(64).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){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(24);e.exports=function(e){return Object(r(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(71),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(148),o=n(100),a=n(41),i=n(13),l=n(15),s=n(75),u=n(6),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(175);for(var r=n(2),o=n(11),a=n(20),i=n(3)("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(12),o=n(60)(1);r(r.P+r.F*!n(40)([].map,!0),"Array",{map:function(e){return o(this,e,arguments[1])}})},function(e,t,n){var r=n(92),o=n(67),a=n(44),i=n(25),l=n(140);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){var r=n(67),o=n(24);e.exports=function(e){return r(o(e))}},function(e,t,n){"use strict";var r=n(12),o=n(60)(2);r(r.P+r.F*!n(40)([].filter,!0),"Array",{filter:function(e){return o(this,e,arguments[1])}})},function(e,t){var n=e.exports={version:"2.6.5"};"number"==typeof __e&&(__e=n)},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(64),o=n(13),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(95)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t,n){var r=n(43);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==r(e)?e.split(""):Object(e)}},function(e,t,n){var r=n(4),o=n(2).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t,n){var r=n(4);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(29);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(73)("keys"),o=n(47);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){var r=n(0),o=n(2),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(30)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t){e.exports={}},function(e,t,n){var r=n(66)("keys"),o=n(65);e.exports=function(e){return r[e]||(r[e]=o(e))}},function(e,t,n){"use strict";var r=n(12),o=n(60)(0),a=n(40)([].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(14);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(98),o=n(74).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return r(e,o)}},function(e,t,n){var r=n(49),o=n(27),a=n(17),i=n(69),l=n(16),s=n(97),u=Object.getOwnPropertyDescriptor;t.f=n(8)?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(30),o=n(1),a=n(104),i=n(11),l=n(20),s=n(173),u=n(32),c=n(102),d=n(3)("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 P)return P[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,A=!1,P=e.prototype,w=P[d]||P["@@iterator"]||m&&P[m],L=w||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&P.entries||w;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&&w&&"values"!==w.name&&(A=!0,L=function(){return w.call(this)}),r&&!_||!f&&!A&&P[d]||i(P,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 P||a(P,b,y[b]);else o(o.P+o.F*(f||A),t,y);return y}},function(e,t,n){t.f=n(3)},function(e,t,n){var r=n(2),o=n(0),a=n(30),i=n(82),l=n(5).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(29);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(26);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);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(171)},function(e,t,n){e.exports=n(198)},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(96);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="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){var r=n(23),o=n(13).document,a=r(o)&&r(o.createElement);e.exports=function(e){return a?o.createElement(e):{}}},function(e,t){e.exports=!1},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,n){e.exports=!n(8)&&!n(14)(function(){return 7!=Object.defineProperty(n(68)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(16),o=n(17),a=n(146)(!1),i=n(72)("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){"use strict";var r=n(95),o=n(12),a=n(41),i=n(15),l=n(75),s=n(151),u=n(101),c=n(156),d=n(6)("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 P)return P[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,A=!1,P=e.prototype,w=P[d]||P["@@iterator"]||m&&P[m],L=w||x(m),M=m?E?x("entries"):L:void 0,S="Array"==t&&P.entries||w;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&&w&&"values"!==w.name&&(A=!0,L=function(){return w.call(this)}),r&&!_||!f&&!A&&P[d]||i(P,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 P||a(P,b,y[b]);else o(o.P+o.F*(f||A),t,y);return y}},function(e,t,n){var r=n(131),o=n(93);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t,n){var r=n(39).f,o=n(42),a=n(6)("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(16),o=n(19),a=n(72)("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(5),o=n(27);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(11)},function(e,t,n){var r=n(2).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(183)},function(e,t,n){var r=n(7);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(20),o=n(3)("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(54),o=n(3)("iterator"),a=n(20);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(3)("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(39).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(7),o=n(26),a=n(3)("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(9),l=n(192),s=n(105),u=n(68),c=n(2),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(29)(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(7),o=n(4),a=n(87);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(2),o=n(0),a=n(5),i=n(8),l=n(3)("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(45),o=n(24);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(4);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(137),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(217)},function(e,t,n){e.exports=n(219)},function(e,t,n){"use strict";var r=n(22),o=n(44),a=n(25),i=n(45),l=n(134),s=n(135),u=Math.max,c=Math.min,d=Math.floor,f=/\$([$&`']|\d\d?|<[^>]*>)/g,h=/\$([$&`']|\d\d?)/g;n(136)("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,P)+O,k=P+A.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(38)(function(){return 7!=Object.defineProperty(n(94)("div"),"a",{get:function(){return 7}}).a})},function(e,t,n){var r=n(23);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(42),o=n(62),a=n(132)(!1),i=n(76)("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(62),o=n(25),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){var r=n(23),o=n(43),a=n(6)("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(118)(!0);e.exports=function(e,t,n){return t+(n?r(e,t).length:1)}},function(e,t,n){"use strict";var r=n(221),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(222);var r=n(41),o=n(15),a=n(38),i=n(24),l=n(6),s=n(120),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(22);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(224)},function(e,t,n){e.exports=n(66)("native-function-to-string",Function.toString)},function(e,t,n){var r=n(141);e.exports=function(e,t){return new(r(e))(t)}},function(e,t,n){var r=n(23),o=n(142),a=n(6)("species");e.exports=function(e){var t;return o(e)&&("function"!=typeof(t=e.constructor)||t!==Array&&!o(t.prototype)||(t=void 0),r(t)&&null===(t=t[a])&&(t=void 0)),void 0===t?Array:t}},function(e,t,n){var r=n(43);e.exports=Array.isArray||function(e){return"Array"==r(e)}},function(e,t,n){n(144),e.exports=n(0).Object.assign},function(e,t,n){var r=n(1);r(r.S+r.F,"Object",{assign:n(145)})},function(e,t,n){"use strict";var r=n(28),o=n(48),a=n(49),i=n(19),l=n(70),s=Object.assign;e.exports=!s||n(14)(function(){var e={},t={},n=Symbol(),r="abcdefghijklmnopqrst";return e[n]=7,r.split("").forEach(function(e){t[e]=e}),7!=s({},e)[n]||Object.keys(s({},t)).join("")!=r})?function(e,t){for(var n=i(e),s=arguments.length,u=1,c=o.f,d=a.f;s>u;)for(var f,h=l(arguments[u++]),p=c?r(h).concat(c(h)):r(h),m=p.length,v=0;m>v;)d.call(h,f=p[v++])&&(n[f]=h[f]);return n}:s},function(e,t,n){var r=n(17),o=n(46),a=n(147);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){var r=n(71),o=Math.max,a=Math.min;e.exports=function(e,t){return(e=r(e))<0?o(e+t,0):a(e,t)}},function(e,t,n){"use strict";var r=n(149),o=n(150),a=n(75),i=n(62);e.exports=n(99)(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){var r=n(6)("unscopables"),o=Array.prototype;null==o[r]&&n(15)(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){"use strict";var r=n(152),o=n(91),a=n(101),i={};n(15)(i,n(6)("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(22),o=n(153),a=n(93),i=n(76)("IE_PROTO"),l=function(){},s=function(){var e,t=n(94)("iframe"),r=a.length;for(t.style.display="none",n(155).appendChild(t),t.src="javascript:",(e=t.contentWindow.document).open(),e.write(" +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/chainspec/index.html b/docs/chainspec/index.html index 6bf500789..8b20d0840 100644 --- a/docs/chainspec/index.html +++ b/docs/chainspec/index.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@

@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 278fb2594..6c42c24bd 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/chainspec/modules/_krummelanke_.html b/docs/chainspec/modules/_krummelanke_.html index 836ff38fc..fcd08dcd9 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/chainspec/modules/_types_.html b/docs/chainspec/modules/_types_.html index 3f6dc148c..1c05b87c7 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:35:18 AM
- +

Type aliases

Chainspec

Ƭ Chainspec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/chainspec/modules/_types_.md b/docs/chainspec/modules/_types_.md index 40f1640be..b84289770 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/815fdc7/packages/chainspec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/packages/chainspec/src/types.ts#L5)* #### Type declaration diff --git a/docs/db/SUMMARY.html b/docs/db/SUMMARY.html index 5d9b76fcc..89bac8153 100644 --- a/docs/db/SUMMARY.html +++ b/docs/db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 94ebdccb3..d1e0c137b 100644 --- a/docs/db/classes/_disk_.diskdb.html +++ b/docs/db/classes/_disk_.diskdb.html @@ -7,7 +7,7 @@ - + @@ -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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_disk_.diskdb.md b/docs/db/classes/_disk_.diskdb.md index 45739da94..b19f99932 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/815fdc7/packages/db/src/Disk.ts#L66)* +*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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 07d8f3990..016caf576 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_engines_filetreedb_.filetreedb.md b/docs/db/classes/_engines_filetreedb_.filetreedb.md index 05f9e3cee..3e1d0d044 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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L21)* +*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L46)* +*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L76)* +*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L50)* +*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L54)* +*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L86)* +*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L68)* +*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L42)* +*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L100)* +*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L58)* +*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/FileTreeDb.ts#L62)* +*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/6506c10/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 a82367bc6..df05d1fa2 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_engines_lrudb_.lrudb.md b/docs/db/classes/_engines_lrudb_.lrudb.md index 1d5afbba9..9a177080a 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/815fdc7/packages/db/src/engines/LruDb.ts#L20)* +*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L87)* +*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L27)* +*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L64)* +*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L41)* +*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L45)* +*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L71)* +*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L56)* +*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L34)* +*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L91)* +*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L52)* +*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/LruDb.ts#L60)* +*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/6506c10/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 b65f14793..091e067d1 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_engines_memorydb_.memorydb.md b/docs/db/classes/_engines_memorydb_.memorydb.md index 5ee06e2d1..3bede2dc6 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/815fdc7/packages/db/src/engines/MemoryDb.ts#L16)* +*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L22)* +*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L56)* +*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L30)* +*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L34)* +*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L62)* +*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L42)* +*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L26)* +*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L68)* +*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L38)* +*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/MemoryDb.ts#L50)* +*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/6506c10/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 1308b48f3..34a89b8cf 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_engines_transactiondb_.transactiondb.md b/docs/db/classes/_engines_transactiondb_.transactiondb.md index 871715a2b..34c50834d 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/815fdc7/packages/db/src/engines/TransactionDb.ts#L21)* +*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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 a217348d3..f6c75f508 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_fileflatdb_cache_.cache.md b/docs/db/classes/_fileflatdb_cache_.cache.md index 9c25a1c87..5aaaadbdc 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/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 e86129fc7..340719b28 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_fileflatdb_compact_.compact.md b/docs/db/classes/_fileflatdb_compact_.compact.md index 756342525..2b450b918 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/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L17)* +*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/FileFlatDb/Compact.ts#L24)* +*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 b29f9bd0d..7551f9655 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_fileflatdb_file_.file.md b/docs/db/classes/_fileflatdb_file_.file.md index ca2012d41..4aaf22e27 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/815fdc7/packages/db/src/FileFlatDb/File.ts#L19)* +*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 bdfb3e3e6..ea2fec04a 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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_fileflatdb_impl_.impl.md b/docs/db/classes/_fileflatdb_impl_.impl.md index e6091eddb..a2cd679cb 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/815fdc7/packages/db/src/FileFlatDb/Cache.ts#L15)* +*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 0e307531a..4c48f4fdc 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:38:56 PM
- +

Hierarchy

Serialize

↳ File

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/classes/_memory_.memory.html b/docs/db/classes/_memory_.memory.html index f84f1d138..5295ff976 100644 --- a/docs/db/classes/_memory_.memory.html +++ b/docs/db/classes/_memory_.memory.html @@ -7,7 +7,7 @@ - + @@ -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:35:18 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:50:54 AM
+ diff --git a/docs/db/classes/_memory_.memory.md b/docs/db/classes/_memory_.memory.md index 078fc5b86..9bd6a6080 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/815fdc7/packages/db/src/Memory.ts#L66)* +*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L51)* +*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L81)* +*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L59)* +*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L63)* +*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L93)* +*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L71)* +*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L55)* +*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L107)* +*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L67)* +*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L77)* +*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/engines/TransactionDb.ts#L29)* +*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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 d01f33bd0..13ec12b18 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:35:18 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:50:54 AM
+ diff --git a/docs/db/enums/_fileflatdb_types_.slot.md b/docs/db/enums/_fileflatdb_types_.slot.md index 1c4fa4f62..3faf06446 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/815fdc7/packages/db/src/FileFlatDb/types.ts#L7)* +*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/FileFlatDb/types.ts#L6)* +*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/FileFlatDb/types.ts#L8)* +*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/6506c10/packages/db/src/FileFlatDb/types.ts#L8)* ___ diff --git a/docs/db/index.html b/docs/db/index.html index 861b20daa..9f2a6391f 100644 --- a/docs/db/index.html +++ b/docs/db/index.html @@ -7,7 +7,7 @@ - + @@ -21,6 +21,6 @@ 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 3cdc1acc2..122badd10 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:35:18 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:50:54 AM
+ diff --git a/docs/db/interfaces/_types_.basedb.md b/docs/db/interfaces/_types_.basedb.md index a8ebb2ce7..96c06e31c 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/815fdc7/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 bf767f6a4..eac9fc94c 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:35:18 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:50:54 AM
+ diff --git a/docs/db/interfaces/_types_.txdb.md b/docs/db/interfaces/_types_.txdb.md index 5fecbdc9d..4865e4d20 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/815fdc7/packages/db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/6506c10/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/db/modules/_disk_.html b/docs/db/modules/_disk_.html index 3d79036ca..89f728dac 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_engines_filetreedb_.html b/docs/db/modules/_engines_filetreedb_.html index 0e42fa62a..4ff13dc1a 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_engines_lrudb_.html b/docs/db/modules/_engines_lrudb_.html index 810625828..39d7920d3 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_engines_memorydb_.html b/docs/db/modules/_engines_memorydb_.html index 832751acf..3de93bc53 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_engines_transactiondb_.html b/docs/db/modules/_engines_transactiondb_.html index 8527357c2..39e632513 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_cache_.html b/docs/db/modules/_fileflatdb_cache_.html index 7ac942494..bfc9869fc 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_compact_.html b/docs/db/modules/_fileflatdb_compact_.html index 495e86bdb..4da33fdf6 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_defaults_.html b/docs/db/modules/_fileflatdb_defaults_.html index beb6262a5..72644e892 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_file_.html b/docs/db/modules/_fileflatdb_file_.html index 627b13c89..610de72a7 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_impl_.html b/docs/db/modules/_fileflatdb_impl_.html index 6cc5b7fd7..a3dee41d5 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_serialize_.html b/docs/db/modules/_fileflatdb_serialize_.html index 95ad4c8bb..35aa32bb3 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_fileflatdb_types_.html b/docs/db/modules/_fileflatdb_types_.html index 742e8cf1c..0379fc87e 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:35:18 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:50:54 AM
+ diff --git a/docs/db/modules/_fileflatdb_types_.md b/docs/db/modules/_fileflatdb_types_.md index d99c31644..fef47cb6a 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/815fdc7/packages/db/src/FileFlatDb/types.ts#L16)* +*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/FileFlatDb/types.ts#L11)* +*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/FileFlatDb/types.ts#L22)* +*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/6506c10/packages/db/src/FileFlatDb/types.ts#L22)* #### Type declaration diff --git a/docs/db/modules/_memory_.html b/docs/db/modules/_memory_.html index e2c847e20..2488464d2 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/db/modules/_types_.html b/docs/db/modules/_types_.html index c1c20e6e4..d2a9f8b77 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:35:18 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:50:54 AM
+ diff --git a/docs/db/modules/_types_.md b/docs/db/modules/_types_.md index 6aeb110a0..ee9877e0f 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/815fdc7/packages/db/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/db/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 364120c29..92b30d505 100644 --- a/docs/examples/keyring/01_create_account/index.html +++ b/docs/examples/keyring/01_create_account/index.html @@ -7,7 +7,7 @@ - + @@ -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 edb69c231..038558d75 100644 --- a/docs/examples/keyring/02_load_accounts/index.html +++ b/docs/examples/keyring/02_load_accounts/index.html @@ -7,7 +7,7 @@ - + @@ -55,6 +55,6 @@ →

- + diff --git a/docs/examples/keyring/index.html b/docs/examples/keyring/index.html index a70c46775..765cd7748 100644 --- a/docs/examples/keyring/index.html +++ b/docs/examples/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ 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;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:38:56 PM
- +
1
2
Last Updated: 2/13/2019, 5:00:38 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 8f5eb6d50..4457d047b 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:38:56 PM
- +

Create Patricia Trie

The following example shows how to create a Patricia Trie.

include

Last Updated: 2/13/2019, 5:00:38 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 a0e010038..ca76faad5 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:38:56 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, 5:00:38 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 b88b2a9b5..c1009826a 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:38:56 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, 5:00:38 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 cc95cbee9..d1c19ae30 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:38:56 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, 5:00:38 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 c2c55d5ea..0c495d52e 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:38:56 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, 5:00:38 PM
+ diff --git a/docs/examples/trie-db/index.html b/docs/examples/trie-db/index.html index f9bec2503..2ca2a9179 100644 --- a/docs/examples/trie-db/index.html +++ b/docs/examples/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ 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;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:38:56 PM
- +
1
2
Last Updated: 2/13/2019, 5:00:38 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 3be137767..fc1256e66 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:38:56 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, 5:00:38 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 1b6a07a71..e130c8c8b 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:38:56 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, 5:00:38 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 391ea8b95..8429d4450 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:38:56 PM
- +

Create & Generate Mnemonic using BIP39

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

include

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/examples/util-crypto/index.html b/docs/examples/util-crypto/index.html index 223276288..3f4893ea5 100644 --- a/docs/examples/util-crypto/index.html +++ b/docs/examples/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ 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;
 yarn start
-
1
2
Last Updated: 2/13/2019, 4:38:56 PM
- +
1
2
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/index.html b/docs/index.html index 96a21056a..c82f3bcd3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@

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 3cd81ecbf..6be851980 100644 --- a/docs/keyring/SUMMARY.html +++ b/docs/keyring/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 ea8c1426d..43b0268b4 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/classes/_pairs_.pairs.md b/docs/keyring/classes/_pairs_.pairs.md index d153d2fd1..b35b82b79 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/815fdc7/packages/keyring/src/pairs.ts#L17)* +*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/pairs.ts#L23)* +*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/pairs.ts#L30)* +*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/pairs.ts#L34)* +*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/pairs.ts#L49)* +*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/pairs.ts#L49)* **Parameters:** diff --git a/docs/keyring/index.html b/docs/keyring/index.html index efdb4c02e..137ba1172 100644 --- a/docs/keyring/index.html +++ b/docs/keyring/index.html @@ -7,7 +7,7 @@ - + @@ -26,6 +26,6 @@ →

- + diff --git a/docs/keyring/interfaces/_types_.keyringinstance.html b/docs/keyring/interfaces/_types_.keyringinstance.html index 42b57a2d4..1bb6c17a5 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringinstance.md b/docs/keyring/interfaces/_types_.keyringinstance.md index 918c75c98..ef80c589e 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/815fdc7/packages/keyring/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/types.ts#L75)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpair.html b/docs/keyring/interfaces/_types_.keyringpair.html index 4b2b986f4..2d36838d1 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringpair.md b/docs/keyring/interfaces/_types_.keyringpair.md index 76f06e1ff..0f07049e5 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/815fdc7/packages/keyring/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/types.ts#L47)* **Parameters:** diff --git a/docs/keyring/interfaces/_types_.keyringpairs.html b/docs/keyring/interfaces/_types_.keyringpairs.html index 358aa46bf..c954c2bb7 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/interfaces/_types_.keyringpairs.md b/docs/keyring/interfaces/_types_.keyringpairs.md index 1546b99d6..7bbbf81ee 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/815fdc7/packages/keyring/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/6506c10/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 061f6046d..888a353fa 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_address_decode_.md b/docs/keyring/modules/_address_decode_.md index 027f5a585..e88136d7a 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/815fdc7/packages/keyring/src/address/decode.ts#L15)* +*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 b85d7b083..9ac005d94 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/keyring/modules/_address_encode_.html b/docs/keyring/modules/_address_encode_.html index ce55b0acd..8aaada517 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_address_encode_.md b/docs/keyring/modules/_address_encode_.md index d6642ebf7..8340e52de 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/815fdc7/packages/keyring/src/address/encode.ts#L15)* +*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 32d47f9e3..7ab6f13ec 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_address_setprefix_.md b/docs/keyring/modules/_address_setprefix_.md index 40fda897f..884833617 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/815fdc7/packages/keyring/src/address/setPrefix.ts#L9)* +*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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 7aa15d883..5e502a669 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:35:18 AM
- +

Type aliases

Prefix

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

Defined in address/types.ts:5

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/keyring/modules/_address_types_.md b/docs/keyring/modules/_address_types_.md index f3d6a736a..6958b908e 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/815fdc7/packages/keyring/src/address/types.ts#L5)* +*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/address/types.ts#L5)* ___ diff --git a/docs/keyring/modules/_pair_decode_.html b/docs/keyring/modules/_pair_decode_.html index e26683b8e..dd49c41f9 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_pair_decode_.md b/docs/keyring/modules/_pair_decode_.md index 587219c26..eb5969b51 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/815fdc7/packages/keyring/src/pair/decode.ts#L19)* +*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 ef02b4954..3df84b717 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/keyring/modules/_pair_encode_.html b/docs/keyring/modules/_pair_encode_.html index 4e5bfbc9f..58a5afca9 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_pair_encode_.md b/docs/keyring/modules/_pair_encode_.md index 284cd0b81..9cb8b6d69 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/815fdc7/packages/keyring/src/pair/encode.ts#L12)* +*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/6506c10/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 3a5ef7ca5..f6e19dd27 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:35:18 AM
- +

Functions

everybody

▸ everybody(): KeyringPair

Defined in pair/nobody.ts:25

Returns: KeyringPair

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/keyring/modules/_pair_nobody_.md b/docs/keyring/modules/_pair_nobody_.md index 8cc29343b..433b26240 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/815fdc7/packages/keyring/src/pair/nobody.ts#L25)* +*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/6506c10/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 8b47b23c8..cb2bd4246 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_pair_tojson_.md b/docs/keyring/modules/_pair_tojson_.md index 1817bd69a..1e38aefc7 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/815fdc7/packages/keyring/src/pair/toJson.ts#L15)* +*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 9b0b72dd6..b1e7d7692 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:35:18 AM
- +

Type aliases

PairInfo

Ƭ PairInfo: object

Defined in pair/types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/keyring/modules/_pair_types_.md b/docs/keyring/modules/_pair_types_.md index 2f7fe6066..e7e764201 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/815fdc7/packages/keyring/src/pair/types.ts#L5)* +*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/pair/types.ts#L5)* #### Type declaration diff --git a/docs/keyring/modules/_pairs_.html b/docs/keyring/modules/_pairs_.html index 9115a8495..894b429c5 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/keyring/modules/_testing_.html b/docs/keyring/modules/_testing_.html index 496cc3dda..a63441317 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_testing_.md b/docs/keyring/modules/_testing_.md index 5cddf1708..8995d8c60 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/815fdc7/packages/keyring/src/testing.ts#L41)* +*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/testing.ts#L41)* *__name__*: testKeyring diff --git a/docs/keyring/modules/_testingpairs_.html b/docs/keyring/modules/_testingpairs_.html index d6e5b0c77..906f06619 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_testingpairs_.md b/docs/keyring/modules/_testingpairs_.md index f16d9a919..c120aa60a 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/815fdc7/packages/keyring/src/testingPairs.ts#L14)* +*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/testingPairs.ts#L14)* **Parameters:** diff --git a/docs/keyring/modules/_types_.html b/docs/keyring/modules/_types_.html index ad078962f..4572281fd 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:35:18 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:50:54 AM
+ diff --git a/docs/keyring/modules/_types_.md b/docs/keyring/modules/_types_.md index 1b1f4ae49..4aadbe6e7 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/815fdc7/packages/keyring/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/keyring/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/6506c10/packages/keyring/src/types.ts#L7)* ___ diff --git a/docs/trie-codec/SUMMARY.html b/docs/trie-codec/SUMMARY.html index c613b4638..83815f11d 100644 --- a/docs/trie-codec/SUMMARY.html +++ b/docs/trie-codec/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 fd900a2c6..689d40790 100644 --- a/docs/trie-codec/classes/_nodeheader_.branchheader.html +++ b/docs/trie-codec/classes/_nodeheader_.branchheader.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@

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 02702ab38..8ff161483 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.extensionheader.md b/docs/trie-codec/classes/_nodeheader_.extensionheader.md index 1c0995ae9..c7a638890 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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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 20ccedd4d..e1586260d 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.leafheader.md b/docs/trie-codec/classes/_nodeheader_.leafheader.md index a8a20dec8..b15d5317d 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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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 3b037ee5e..ec1f7c2ed 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.nibbleheader.md b/docs/trie-codec/classes/_nodeheader_.nibbleheader.md index bdfadc270..a6d1445b0 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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L21)* +*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L27)* +*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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 d2e76668a..73c49cfa2 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/classes/_nodeheader_.nodeheader.md b/docs/trie-codec/classes/_nodeheader_.nodeheader.md index 114eb13ea..6723c89b8 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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L40)* +*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L92)* +*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L114)* +*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L118)* +*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/NodeHeader.ts#L122)* +*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/6506c10/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 c462401b4..5c1a0210c 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:38:56 PM
- +

Hierarchy

Null

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-codec/index.html b/docs/trie-codec/index.html index 97a954de3..540c9313a 100644 --- a/docs/trie-codec/index.html +++ b/docs/trie-codec/index.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@

@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 365f33ee6..8845b4978 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_constants_.md b/docs/trie-codec/modules/_constants_.md index 5cfcdc209..bb8420c8a 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/815fdc7/packages/trie-codec/src/constants.ts#L10)* +*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L11)* +*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L5)* +*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L8)* +*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L15)* +*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L13)* +*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L7)* +*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L6)* +*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L12)* +*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L17)* +*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L18)* +*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L19)* +*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/constants.ts#L16)* +*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/6506c10/packages/trie-codec/src/constants.ts#L16)* ___ diff --git a/docs/trie-codec/modules/_decode_.html b/docs/trie-codec/modules/_decode_.html index cf53cdfbd..d91ed2155 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_decode_.md b/docs/trie-codec/modules/_decode_.md index 9c4140c35..54ed9b73c 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/815fdc7/packages/trie-codec/src/decode.ts#L95)* +*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/6506c10/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 41187d785..a80969481 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_encode_.md b/docs/trie-codec/modules/_encode_.md index 7efc3cc4b..d705b5b2d 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/815fdc7/packages/trie-codec/src/encode.ts#L101)* +*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/6506c10/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 15b39d8b0..9a346f056 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-codec/modules/_nibbles_.html b/docs/trie-codec/modules/_nibbles_.html index 2ed61392b..1778bdf06 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_nibbles_.md b/docs/trie-codec/modules/_nibbles_.md index 5ac60ed32..d8aa32d28 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/815fdc7/packages/trie-codec/src/nibbles.ts#L31)* +*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L52)* +*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L65)* +*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L15)* +*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L21)* +*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L27)* +*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-codec/src/nibbles.ts#L44)* +*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/6506c10/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 8c77c226e..4a8431d1b 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-codec/modules/_stream_createbranch_.html b/docs/trie-codec/modules/_stream_createbranch_.html index 3be9a5dc2..19917b230 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createbranch_.md b/docs/trie-codec/modules/_stream_createbranch_.md index 1820e4f9e..fbc41bfbf 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/815fdc7/packages/trie-codec/src/stream/createBranch.ts#L10)* +*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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 bd68372d5..69ea6cdb6 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:35:18 AM
- +

Functions

createEmpty

▸ createEmpty(): Uint8Array

Defined in stream/createEmpty.ts:7

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createempty_.md b/docs/trie-codec/modules/_stream_createempty_.md index 091214670..02db2a699 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/815fdc7/packages/trie-codec/src/stream/createEmpty.ts#L7)* +*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 26f7b48b0..16bcc4c4b 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createextension_.md b/docs/trie-codec/modules/_stream_createextension_.md index c813710ae..86b810d2c 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/815fdc7/packages/trie-codec/src/stream/createExtension.ts#L7)* +*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 80701035a..c05ec8f8c 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createleaf_.md b/docs/trie-codec/modules/_stream_createleaf_.md index da00f33b5..2b56df3f1 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/815fdc7/packages/trie-codec/src/stream/createLeaf.ts#L10)* +*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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 c2be695d9..0c9bb1e52 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createsubstream_.md b/docs/trie-codec/modules/_stream_createsubstream_.md index 77a14d6e3..fda3ef052 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/815fdc7/packages/trie-codec/src/stream/createSubstream.ts#L8)* +*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/6506c10/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 82ff6d5c5..3d4e127f5 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_createvalue_.md b/docs/trie-codec/modules/_stream_createvalue_.md index bc95913b6..14195ed94 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/815fdc7/packages/trie-codec/src/stream/createValue.ts#L9)* +*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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 613e596d8..c072117e5 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_stream_endbranch_.md b/docs/trie-codec/modules/_stream_endbranch_.md index 5de997bfb..8a7e04e4d 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/815fdc7/packages/trie-codec/src/stream/endBranch.ts#L7)* +*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 c6897c688..e7d39e2a4 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:35:18 AM
- +

Type aliases

Codec

Ƭ Codec: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/trie-codec/modules/_types_.md b/docs/trie-codec/modules/_types_.md index f093583be..941054fd9 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/815fdc7/packages/trie-codec/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 004ac5823..f1bb035b1 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/trie-codec/modules/_util_fromnibbles_.md b/docs/trie-codec/modules/_util_fromnibbles_.md index cc6fbe843..ed6465e01 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/815fdc7/packages/trie-codec/src/util/fromNibbles.ts#L19)* +*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 e4c485b16..8892e86a9 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_util_fusenibbles_.md b/docs/trie-codec/modules/_util_fusenibbles_.md index e28c42dae..98eebfc21 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/815fdc7/packages/trie-codec/src/util/fuseNibbles.ts#L12)* +*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/6506c10/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 12c6cbbf3..548cb22b7 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-codec/modules/_util_sharedprefixlength_.md b/docs/trie-codec/modules/_util_sharedprefixlength_.md index 2750809cf..790bb0b1c 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/815fdc7/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)* +*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 4bafc7ace..4df7e9c9d 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional input Uint8Array | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/trie-codec/modules/_util_tonibbles_.md b/docs/trie-codec/modules/_util_tonibbles_.md index 8eb42c5a9..2a4acf940 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/815fdc7/packages/trie-codec/src/util/toNibbles.ts#L19)* +*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 2eee7dbac..959723ce4 100644 --- a/docs/trie-db/SUMMARY.html +++ b/docs/trie-db/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 647659436..1ecdbc071 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/classes/_checkpoint_.checkpoint.md b/docs/trie-db/classes/_checkpoint_.checkpoint.md index ac8633792..b0c627eb9 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/815fdc7/packages/trie-db/src/Checkpoint.ts#L7)* +*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 5526ec6f2..3f48ff600 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/classes/_impl_.impl.md b/docs/trie-db/classes/_impl_.impl.md index ba843b151..55e6050fc 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/815fdc7/packages/trie-db/src/Impl.ts#L38)* +*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/Impl.ts#L36)* +*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/6506c10/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 2f3f6138d..f74f3f3f9 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/enums/_types_.nodetype.md b/docs/trie-db/enums/_types_.nodetype.md index fc680f128..595847046 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/815fdc7/packages/trie-db/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/6506c10/packages/trie-db/src/types.ts#L9)* ___ diff --git a/docs/trie-db/index.html b/docs/trie-db/index.html index 2a112d7b4..610df35ba 100644 --- a/docs/trie-db/index.html +++ b/docs/trie-db/index.html @@ -7,7 +7,7 @@ - + @@ -18,6 +18,6 @@

@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 2efc02697..fd9f3254f 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/interfaces/_types_.triedb.md b/docs/trie-db/interfaces/_types_.triedb.md index 9e091be93..144ea9d74 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/815fdc7/packages/trie-db/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/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/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/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/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/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/6506c10/packages/db/src/types.ts#L32)* **Parameters:** diff --git a/docs/trie-db/modules/_checkpoint_.html b/docs/trie-db/modules/_checkpoint_.html index 237b16360..753fd57f8 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-db/modules/_constants_.html b/docs/trie-db/modules/_constants_.html index 97df49e3c..548e3c1b1 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/modules/_constants_.md b/docs/trie-db/modules/_constants_.md index d3954f5b0..4aa27e9b3 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/815fdc7/packages/trie-db/src/constants.ts#L9)* +*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/constants.ts#L14)* +*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/6506c10/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 48b661add..356e20d13 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-db/modules/_impl_.html b/docs/trie-db/modules/_impl_.html index 4dbeb646b..d3f0fe0fa 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-db/modules/_types_.html b/docs/trie-db/modules/_types_.html index e35057f83..0428fbee2 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/modules/_types_.md b/docs/trie-db/modules/_types_.md index 75debb6b6..5357e5469 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/815fdc7/packages/trie-db/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/6506c10/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 f2c3f67c8..10ab54a03 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/modules/_util_is_.md b/docs/trie-db/modules/_util_is_.md index 52657e5d7..4f500844c 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/815fdc7/packages/trie-db/src/util/is.ts#L52)* +*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/is.ts#L16)* +*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/is.ts#L34)* +*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/is.ts#L25)* +*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/is.ts#L43)* +*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/6506c10/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 5117ca3e7..cc1a65fa3 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/modules/_util_key_.md b/docs/trie-db/modules/_util_key_.md index 561e41a10..5f1df643d 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/815fdc7/packages/trie-db/src/util/key.ts#L36)* +*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/key.ts#L40)* +*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/key.ts#L56)* +*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/key.ts#L46)* +*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/key.ts#L10)* +*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/key.ts#L20)* +*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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 0a9f9bb50..9f024ebdc 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-db/modules/_util_node_.md b/docs/trie-db/modules/_util_node_.md index 8aaf93f9f..cb99b488a 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/815fdc7/packages/trie-db/src/util/node.ts#L30)* +*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/node.ts#L46)* +*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/trie-db/src/util/node.ts#L13)* +*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/6506c10/packages/trie-db/src/util/node.ts#L13)* **Parameters:** diff --git a/docs/trie-hash/SUMMARY.html b/docs/trie-hash/SUMMARY.html index 48adb0576..6375e1089 100644 --- a/docs/trie-hash/SUMMARY.html +++ b/docs/trie-hash/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/trie-hash/index.html b/docs/trie-hash/index.html index 637765dc7..72a22669e 100644 --- a/docs/trie-hash/index.html +++ b/docs/trie-hash/index.html @@ -7,7 +7,7 @@ - + @@ -18,6 +18,6 @@

@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 30251454f..889e5d892 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-hash/modules/_buildtrie_.md b/docs/trie-hash/modules/_buildtrie_.md index 2be0c0c61..55133b4d8 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/815fdc7/packages/trie-hash/src/buildTrie.ts#L77)* +*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/6506c10/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 ee6dfad81..6aa8d8b12 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/trie-hash/modules/_trieroot_.html b/docs/trie-hash/modules/_trieroot_.html index 058e7da6a..b050a85ce 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-hash/modules/_trieroot_.md b/docs/trie-hash/modules/_trieroot_.md index 41eb15793..1eb3e4b3f 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/815fdc7/packages/trie-hash/src/trieRoot.ts#L29)* +*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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 a93c8f068..4c4c16780 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-hash/modules/_trierootordered_.md b/docs/trie-hash/modules/_trierootordered_.md index a166a53e9..0ef6cd83a 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/815fdc7/packages/trie-hash/src/trieRootOrdered.ts#L30)* +*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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 5bc2596b8..ad67bfcbd 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:35:18 AM
- +

Type aliases

TriePair

Ƭ TriePair: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/trie-hash/modules/_types_.md b/docs/trie-hash/modules/_types_.md index ca79c15d6..f559e73bb 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/815fdc7/packages/trie-hash/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 9a2b44635..dead95feb 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:35:18 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:50:54 AM
+ diff --git a/docs/trie-hash/modules/_unhashedtrie_.md b/docs/trie-hash/modules/_unhashedtrie_.md index e9854e2ae..6cb078cee 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/815fdc7/packages/trie-hash/src/unhashedTrie.ts#L14)* +*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/6506c10/packages/trie-hash/src/unhashedTrie.ts#L14)* **Parameters:** diff --git a/docs/util-crypto/SUMMARY.html b/docs/util-crypto/SUMMARY.html index 0a5690ab8..de9986d12 100644 --- a/docs/util-crypto/SUMMARY.html +++ b/docs/util-crypto/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/util-crypto/index.html b/docs/util-crypto/index.html index fbed55bce..7f96040ee 100644 --- a/docs/util-crypto/index.html +++ b/docs/util-crypto/index.html @@ -7,7 +7,7 @@ - + @@ -26,6 +26,6 @@ →

- + diff --git a/docs/util-crypto/modules/_blake2_ashex_.html b/docs/util-crypto/modules/_blake2_ashex_.html index a8c8146e4..7df03125b 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_blake2_ashex_.md b/docs/util-crypto/modules/_blake2_ashex_.md index fb4b4a43d..c4edccdf3 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/815fdc7/packages/util-crypto/src/blake2/asHex.ts#L21)* +*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 fc3ae650f..f7906bd28 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_blake2_asu8a_.md b/docs/util-crypto/modules/_blake2_asu8a_.md index 0d9d88aeb..7fc46af4b 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/815fdc7/packages/util-crypto/src/blake2/asU8a.ts#L21)* +*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 2b5de65d1..bcfd747fc 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_blake2_blake2b_ashex_.md b/docs/util-crypto/modules/_blake2_blake2b_ashex_.md index dab14a4fa..627bf05d7 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/815fdc7/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)* +*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 e2834d8fc..34560869d 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md b/docs/util-crypto/modules/_blake2_blake2b_asu8a_.md index e54e4d43f..cb9d14329 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/815fdc7/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)* +*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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 2079b7326..d2ed66fee 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_keccak_ashex_.md b/docs/util-crypto/modules/_keccak_ashex_.md index bbd04113a..3b1a0cc39 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/815fdc7/packages/util-crypto/src/keccak/asHex.ts#L23)* +*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 3fa9c0501..f8e558c64 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value Buffer | Uint8Array | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_keccak_asu8a_.md b/docs/util-crypto/modules/_keccak_asu8a_.md index 6333282eb..8ea1883d1 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/815fdc7/packages/util-crypto/src/keccak/asU8a.ts#L21)* +*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 43f0b4916..b424d88ed 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional strength Strength

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_generate_.md b/docs/util-crypto/modules/_mnemonic_generate_.md index 740feb3e8..454b497e9 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/815fdc7/packages/util-crypto/src/mnemonic/generate.ts#L21)* +*Defined in [mnemonic/generate.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 d86a6ec36..0767d4ffe 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_tosecret_.md b/docs/util-crypto/modules/_mnemonic_tosecret_.md index 23779ff7b..8570e2b55 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/815fdc7/packages/util-crypto/src/mnemonic/toSecret.ts#L8)* +*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/6506c10/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 69e77e3db..d8cb8a630 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:35:18 AM
- +
1
2
3
4
5
6
7
8

Parameters:

Name Type
mnemonic string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_toseed_.md b/docs/util-crypto/modules/_mnemonic_toseed_.md index c91130d64..42a617400 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/815fdc7/packages/util-crypto/src/mnemonic/toSeed.ts#L24)* +*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 b61e4d313..f49640fff 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:35:18 AM
- +
1
2
3
4

Parameters:

Name Type
mnemonic string

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_mnemonic_validate_.md b/docs/util-crypto/modules/_mnemonic_validate_.md index 4900c4cbf..c8467e779 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/815fdc7/packages/util-crypto/src/mnemonic/validate.ts#L20)* +*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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 2ae4cda3a..7b0ff338c 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
encrypted Uint8Array
nonce Uint8Array
secret Uint8Array

Returns: Uint8Array | null

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_decrypt_.md b/docs/util-crypto/modules/_nacl_decrypt_.md index 6bb0ecf47..485b1becf 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/815fdc7/packages/util-crypto/src/nacl/decrypt.ts#L21)* +*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 872d44211..0fc8bdfd5 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_encrypt_.md b/docs/util-crypto/modules/_nacl_encrypt_.md index f572124bf..5ed2731a0 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/815fdc7/packages/util-crypto/src/nacl/encrypt.ts#L28)* +*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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 b1cb90f8d..4389fa6f1 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:35:18 AM
- +
1
2
3

Returns: KeypairType

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md b/docs/util-crypto/modules/_nacl_keypair_fromrandom_.md index 8c8f4f67a..8d9195741 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/815fdc7/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)* +*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 cda47bdd5..7b16c4446 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
secret Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md b/docs/util-crypto/modules/_nacl_keypair_fromsecret_.md index d03d2d97f..a199df50e 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/815fdc7/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)* +*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 710105b46..78dff3f8f 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
seed Uint8Array

Returns: KeypairType

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromseed_.md b/docs/util-crypto/modules/_nacl_keypair_fromseed_.md index c4722d854..3f8645eef 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/815fdc7/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)* +*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 2d0db232e..d3d809b58 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value string

Returns: KeypairType

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_keypair_fromstring_.md b/docs/util-crypto/modules/_nacl_keypair_fromstring_.md index f79a181a6..ddfbff14b 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/815fdc7/packages/util-crypto/src/nacl/keypair/fromString.ts#L26)* +*Defined in [nacl/keypair/fromString.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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 16deaf772..86f9e2849 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
__namedParameters object

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_sign_.md b/docs/util-crypto/modules/_nacl_sign_.md index 53b4ba8e6..cb2e04a05 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/815fdc7/packages/util-crypto/src/nacl/sign.ts#L24)* +*Defined in [nacl/sign.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 d08cac2a8..3ae4e14aa 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
message Uint8Array
signature Uint8Array
publicKey Uint8Array

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_nacl_verify_.md b/docs/util-crypto/modules/_nacl_verify_.md index 1c6f63d51..98f1aa1c3 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/815fdc7/packages/util-crypto/src/nacl/verify.ts#L21)* +*Defined in [nacl/verify.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 84d48f9c2..aae41b4a4 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:35:18 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_random_ashex_.md b/docs/util-crypto/modules/_random_ashex_.md index a90e1c9ba..b245a66cb 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/815fdc7/packages/util-crypto/src/random/asHex.ts#L23)* +*Defined in [random/asHex.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 8d59ee36d..0690aa5b9 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:35:18 AM
- +
1
2
3

Returns: number

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_random_asnumber_.md b/docs/util-crypto/modules/_random_asnumber_.md index a90009ba9..ae6978df7 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/815fdc7/packages/util-crypto/src/random/asNumber.ts#L26)* +*Defined in [random/asNumber.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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 6765c98d1..76ee44a8d 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:35:18 AM
- +
1
2
3

Parameters:

Name Type Default value
Default value length number 32

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_random_asu8a_.md b/docs/util-crypto/modules/_random_asu8a_.md index 8cebeb632..a16a67d6f 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/815fdc7/packages/util-crypto/src/random/asU8a.ts#L21)* +*Defined in [random/asU8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 ab8da608d..6abb5668c 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md b/docs/util-crypto/modules/_schnorrkel_keypair_fromseed_.md index bec56edcc..8f1e2f25f 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/815fdc7/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts#L16)* +*Defined in [schnorrkel/keypair/fromSeed.ts:16](https://github.com/polkadot-js/common/blob/6506c10/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 38ae800e0..89ce3e9d9 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_ready_.md b/docs/util-crypto/modules/_schnorrkel_ready_.md index 91f7152fb..98c740e8b 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/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L11)* +*Defined in [schnorrkel/ready.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util-crypto/src/schnorrkel/ready.ts#L7)* +*Defined in [schnorrkel/ready.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 043468d26..61aa613fe 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_sign_.md b/docs/util-crypto/modules/_schnorrkel_sign_.md index 1ad0a1259..ca5c2951f 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/815fdc7/packages/util-crypto/src/schnorrkel/sign.ts#L15)* +*Defined in [schnorrkel/sign.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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 ce831befd..49305a0fc 100644 --- a/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html +++ b/docs/util-crypto/modules/_schnorrkel_test_polyfill_.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 0606f0405..8aa5f61dd 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_schnorrkel_verify_.md b/docs/util-crypto/modules/_schnorrkel_verify_.md index 90984f5df..e9d05f61c 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/815fdc7/packages/util-crypto/src/schnorrkel/verify.ts#L11)* +*Defined in [schnorrkel/verify.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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 e2c30e4cb..a952b6131 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_secp256k1_recover_.md b/docs/util-crypto/modules/_secp256k1_recover_.md index 42e5d3823..4dc39bec3 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/815fdc7/packages/util-crypto/src/secp256k1/recover.ts#L12)* +*Defined in [secp256k1/recover.ts:12](https://github.com/polkadot-js/common/blob/6506c10/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 d3ff5d071..3f8b16f79 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
data Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_sha512_asu8a_.md b/docs/util-crypto/modules/_sha512_asu8a_.md index 038960a04..8a9dd2459 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/815fdc7/packages/util-crypto/src/sha512/asU8a.ts#L21)* +*Defined in [sha512/asU8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 7fcbb4eef..29e19b4e2 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:35:18 AM
- +

Type aliases

KeypairType

Ƭ KeypairType: object

Defined in types.ts:5

Type declaration

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_types_.md b/docs/util-crypto/modules/_types_.md index 8d87006f9..04cc45d99 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/815fdc7/packages/util-crypto/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 9afeee0a8..72ee501fb 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_ashex_.md b/docs/util-crypto/modules/_xxhash_ashex_.md index 915564dfe..a1c96f60c 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/815fdc7/packages/util-crypto/src/xxhash/asHex.ts#L23)* +*Defined in [xxhash/asHex.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 bec694682..2f4c2ce34 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:35:18 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:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_asu8a_.md b/docs/util-crypto/modules/_xxhash_asu8a_.md index 286c50de1..a74b845aa 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/815fdc7/packages/util-crypto/src/xxhash/asU8a.ts#L21)* +*Defined in [xxhash/asU8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 46a56504f..f9838f0d0 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: BN

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asbn_.md index 6a15ba666..a449973ec 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/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asBn.ts#L23)* +*Defined in [xxhash/xxhash64/asBn.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 06044e7ba..eec13ffa5 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md b/docs/util-crypto/modules/_xxhash_xxhash64_ashex_.md index 4cdaa54ae..eb5c1a23d 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/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asHex.ts#L23)* +*Defined in [xxhash/xxhash64/asHex.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 b5cffcbf0..93573e418 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asraw_.md index 71e5aa03a..2150aa9de 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/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asRaw.ts#L21)* +*Defined in [xxhash/xxhash64/asRaw.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 c48114690..71ba3ccc2 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
data Buffer | Uint8Array | string
seed number

Returns: number

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md b/docs/util-crypto/modules/_xxhash_xxhash64_asvalue_.md index 7d2282a03..ca22ec609 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/815fdc7/packages/util-crypto/src/xxhash/xxhash64/asValue.ts#L22)* +*Defined in [xxhash/xxhash64/asValue.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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 6f7061e18..9c5e2127c 100644 --- a/docs/util-rlp/SUMMARY.html +++ b/docs/util-rlp/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
Last Updated: 2/26/2019, 11:08:42 AM
- + diff --git a/docs/util-rlp/index.html b/docs/util-rlp/index.html index 4e822902b..eff2d143d 100644 --- a/docs/util-rlp/index.html +++ b/docs/util-rlp/index.html @@ -7,7 +7,7 @@ - + @@ -19,6 +19,6 @@
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 d3b1f3d03..ddad239e5 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util-rlp/modules/_decoder_decode_.html b/docs/util-rlp/modules/_decoder_decode_.html index 3f0d347ab..75db622a1 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_decode_.md b/docs/util-rlp/modules/_decoder_decode_.md index 2e5d54d2b..804464b67 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/815fdc7/packages/util-rlp/src/decoder/decode.ts#L28)* +*Defined in [decoder/decode.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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 f124980f4..6aef1fa03 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_listlong_.md b/docs/util-rlp/modules/_decoder_listlong_.md index 00e2fd2bc..d079481e9 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/815fdc7/packages/util-rlp/src/decoder/listLong.ts#L11)* +*Defined in [decoder/listLong.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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 da1f5e67a..941cb44b1 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_listshort_.md b/docs/util-rlp/modules/_decoder_listshort_.md index 2e01e68b7..45a4ecd2c 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/815fdc7/packages/util-rlp/src/decoder/listShort.ts#L7)* +*Defined in [decoder/listShort.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 b661a269b..4b96bfeaa 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_number_.md b/docs/util-rlp/modules/_decoder_number_.md index e36fe59b0..14c10c72f 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/815fdc7/packages/util-rlp/src/decoder/number.ts#L11)* +*Defined in [decoder/number.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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 ad8df1ad1..8dd7eaba2 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_safeparseint_.md b/docs/util-rlp/modules/_decoder_safeparseint_.md index 59a079f99..8168bbffa 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/815fdc7/packages/util-rlp/src/decoder/safeParseInt.ts#L7)* +*Defined in [decoder/safeParseInt.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 f92071561..b5c744dca 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_single_.md b/docs/util-rlp/modules/_decoder_single_.md index d6a6c6ab2..2052df086 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/815fdc7/packages/util-rlp/src/decoder/single.ts#L7)* +*Defined in [decoder/single.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 358c6deb1..e3e576f81 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_string_.md b/docs/util-rlp/modules/_decoder_string_.md index f8e4363a5..3808031e2 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/815fdc7/packages/util-rlp/src/decoder/string.ts#L9)* +*Defined in [decoder/string.ts:9](https://github.com/polkadot-js/common/blob/6506c10/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 34fe24590..a978287e8 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_decoder_types_.md b/docs/util-rlp/modules/_decoder_types_.md index 6da1b372a..4bb8c34a5 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/815fdc7/packages/util-rlp/src/decoder/types.ts#L10)* +*Defined in [decoder/types.ts:10](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util-rlp/src/decoder/types.ts#L5)* +*Defined in [decoder/types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 f7eb499c4..7eb12108d 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util-rlp/modules/_encoder_array_.html b/docs/util-rlp/modules/_encoder_array_.html index bce44d88c..52aed891f 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_encoder_array_.md b/docs/util-rlp/modules/_encoder_array_.md index 05e80ce8c..2fd78958a 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/815fdc7/packages/util-rlp/src/encoder/array.ts#L11)* +*Defined in [encoder/array.ts:11](https://github.com/polkadot-js/common/blob/6506c10/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 b33d19193..e09ed58c7 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_encoder_length_.md b/docs/util-rlp/modules/_encoder_length_.md index 5658d6c6b..795f3e5ac 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/815fdc7/packages/util-rlp/src/encoder/length.ts#L7)* +*Defined in [encoder/length.ts:7](https://github.com/polkadot-js/common/blob/6506c10/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 c72a9af22..dadd3ce2c 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_encoder_tou8a_.md b/docs/util-rlp/modules/_encoder_tou8a_.md index 7079eac84..4a6f2a913 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/815fdc7/packages/util-rlp/src/encoder/toU8a.ts#L39)* +*Defined in [encoder/toU8a.ts:39](https://github.com/polkadot-js/common/blob/6506c10/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 4b7b94c39..fa968ebf8 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_encoder_types_.md b/docs/util-rlp/modules/_encoder_types_.md index b6602b922..84ec43750 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/815fdc7/packages/util-rlp/src/encoder/types.ts#L5)* +*Defined in [encoder/types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/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 ceeeae60c..4071e3a59 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:35:18 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:50:54 AM
+ diff --git a/docs/util-rlp/modules/_encoder_u8a_.md b/docs/util-rlp/modules/_encoder_u8a_.md index ae3a06ddb..6f0570897 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/815fdc7/packages/util-rlp/src/encoder/u8a.ts#L11)* +*Defined in [encoder/u8a.ts:11](https://github.com/polkadot-js/common/blob/6506c10/packages/util-rlp/src/encoder/u8a.ts#L11)* **Parameters:** diff --git a/docs/util/SUMMARY.html b/docs/util/SUMMARY.html index 2fa916e8b..dbf4c3f87 100644 --- a/docs/util/SUMMARY.html +++ b/docs/util/SUMMARY.html @@ -7,7 +7,7 @@ - + @@ -16,6 +16,6 @@
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 37a2a19c4..c8b924fdf 100644 --- a/docs/util/classes/_ext_error_.exterror.html +++ b/docs/util/classes/_ext_error_.exterror.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@

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:35:18 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:50:54 AM
+ diff --git a/docs/util/classes/_ext_error_.exterror.md b/docs/util/classes/_ext_error_.exterror.md index 32ddb0fdb..703c1da63 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/815fdc7/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L35)* +*Defined in [ext/error.ts:35](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L37)* +*Defined in [ext/error.ts:37](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L39)* +*Defined in [ext/error.ts:39](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L41)* +*Defined in [ext/error.ts:41](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L43)* +*Defined in [ext/error.ts:43](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L60)* +*Defined in [ext/error.ts:60](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L61)* +*Defined in [ext/error.ts:61](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L63)* +*Defined in [ext/error.ts:63](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L64)* +*Defined in [ext/error.ts:64](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/ext/error.ts#L62)* +*Defined in [ext/error.ts:62](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/ext/error.ts#L62)* ___ diff --git a/docs/util/index.html b/docs/util/index.html index 66ccca299..dbe86ee4a 100644 --- a/docs/util/index.html +++ b/docs/util/index.html @@ -7,7 +7,7 @@ - + @@ -26,6 +26,6 @@ →

- + diff --git a/docs/util/interfaces/_types_.exterrorinterface.html b/docs/util/interfaces/_types_.exterrorinterface.html index f433a841b..2cbc49bc3 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:35:18 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:50:54 AM
+ diff --git a/docs/util/interfaces/_types_.exterrorinterface.md b/docs/util/interfaces/_types_.exterrorinterface.md index a8fe89f0f..2b90a8e27 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/815fdc7/packages/util/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L6)* ___ @@ -25,7 +25,7 @@ ___ **● data**: *`any`* -*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L7)* ___ @@ -34,7 +34,7 @@ ___ **● message**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L8)* ___ @@ -43,7 +43,7 @@ ___ **● stack**: *`string`* -*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/815fdc7/packages/util/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L9)* ___ diff --git a/docs/util/interfaces/_types_.tobnoptions.html b/docs/util/interfaces/_types_.tobnoptions.html index 2c2acb23a..1b924f891 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:35:18 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:50:54 AM
+ diff --git a/docs/util/interfaces/_types_.tobnoptions.md b/docs/util/interfaces/_types_.tobnoptions.md index ba8b258f5..9a03091dd 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/815fdc7/packages/util/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L25)* ___ diff --git a/docs/util/modules/_array_filter_.html b/docs/util/modules/_array_filter_.html index 58c8dd9c9..f67acfae5 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_array_filter_.md b/docs/util/modules/_array_filter_.md index d5b101163..9b197699c 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/815fdc7/packages/util/src/array/filter.ts#L23)* +*Defined in [array/filter.ts:23](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/array/filter.ts#L23)* *__name__*: arrayFilter diff --git a/docs/util/modules/_assert_.html b/docs/util/modules/_assert_.html index e65b69d62..dd93b1cf8 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_assert_.md b/docs/util/modules/_assert_.md index d16a0779c..e03e0f500 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/815fdc7/packages/util/src/assert.ts#L28)* +*Defined in [assert.ts:28](https://github.com/polkadot-js/common/blob/6506c10/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 c15a69303..cc2a53e8b 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_bn_tobn_.html b/docs/util/modules/_bn_tobn_.html index 17bac4499..41d33cadf 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:35:18 AM
- +
1
2
3
4
5

Parameters:

Name Type
Optional value BN | number | null

Returns: BN

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_bn_tobn_.md b/docs/util/modules/_bn_tobn_.md index 48ee1cc09..3b4b853ec 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/815fdc7/packages/util/src/bn/toBn.ts#L23)* +*Defined in [bn/toBn.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 c48a5bb08..190ca4407 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_bn_tohex_.md b/docs/util/modules/_bn_tohex_.md index 503677ff6..ceafc1951 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/815fdc7/packages/util/src/bn/toHex.ts#L33)* +*Defined in [bn/toHex.ts:33](https://github.com/polkadot-js/common/blob/6506c10/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 6127790b9..245df99e3 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_bn_tou8a_.md b/docs/util/modules/_bn_tou8a_.md index d913dbcec..744d184dc 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/815fdc7/packages/util/src/bn/toU8a.ts#L29)* +*Defined in [bn/toU8a.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/bn/toU8a.ts#L30)* +*Defined in [bn/toU8a.ts:30](https://github.com/polkadot-js/common/blob/6506c10/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 e542f0737..05e665102 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional buffer Buffer | number[] | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_buffer_tou8a_.md b/docs/util/modules/_buffer_tou8a_.md index e78476563..b56bdea73 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/815fdc7/packages/util/src/buffer/toU8a.ts#L19)* +*Defined in [buffer/toU8a.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 e5eb2c80d..f8a4e22b1 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_compact_addlength_.md b/docs/util/modules/_compact_addlength_.md index 0a1a12cab..cac15044b 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/815fdc7/packages/util/src/compact/addLength.ts#L20)* +*Defined in [compact/addLength.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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 b1a13e13d..f57743820 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:35:18 AM
- +

Variables

<Const> DEFAULT_BITLENGTH

● DEFAULT_BITLENGTH: BitLength = 32

Defined in compact/defaults.ts:7

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_compact_defaults_.md b/docs/util/modules/_compact_defaults_.md index 9f8f5fd3d..ba9fc4e7a 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/815fdc7/packages/util/src/compact/defaults.ts#L7)* +*Defined in [compact/defaults.ts:7](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/compact/defaults.ts#L7)* ___ diff --git a/docs/util/modules/_compact_fromu8a_.html b/docs/util/modules/_compact_fromu8a_.html index fbdee961c..03cc07367 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_compact_fromu8a_.md b/docs/util/modules/_compact_fromu8a_.md index b7466486a..3091eacd7 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/815fdc7/packages/util/src/compact/fromU8a.ts#L26)* +*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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 e3fc8ca70..c0f4ddea1 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_compact_striplength_.md b/docs/util/modules/_compact_striplength_.md index dd5b92456..2256928d4 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/815fdc7/packages/util/src/compact/stripLength.ts#L22)* +*Defined in [compact/stripLength.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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 4f9031583..7ff598d32 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
_value BN | number

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_compact_tou8a_.md b/docs/util/modules/_compact_tou8a_.md index 9e6b0a520..215a27a9d 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/815fdc7/packages/util/src/compact/toU8a.ts#L27)* +*Defined in [compact/toU8a.ts:27](https://github.com/polkadot-js/common/blob/6506c10/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 e3f46ba6c..c36119e91 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:35:18 AM
- +

Type aliases

BitLength

Ƭ BitLength: 8 | 16 | 32 | 64 | 128 | 256

Defined in compact/types.ts:5

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_compact_types_.md b/docs/util/modules/_compact_types_.md index 594d6ea96..955456b22 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/815fdc7/packages/util/src/compact/types.ts#L5)* +*Defined in [compact/types.ts:5](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/compact/types.ts#L5)* ___ diff --git a/docs/util/modules/_ext_error_.html b/docs/util/modules/_ext_error_.html index 48d956f29..a81b3aabe 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:38:56 PM
- +

Index

Classes

Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_hex_addprefix_.html b/docs/util/modules/_hex_addprefix_.html index 056657cb1..13497d4d2 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_hex_addprefix_.md b/docs/util/modules/_hex_addprefix_.md index 300fcef83..9a2857a8c 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/815fdc7/packages/util/src/hex/addPrefix.ts#L21)* +*Defined in [hex/addPrefix.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 9043e6985..e292f1129 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_hex_fixlength_.md b/docs/util/modules/_hex_fixlength_.md index 3d880461d..cddf0fa9b 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/815fdc7/packages/util/src/hex/fixLength.ts#L24)* +*Defined in [hex/fixLength.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 0cf6b7bf5..e628ceed2 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_hex_hasprefix_.md b/docs/util/modules/_hex_hasprefix_.md index 207bce984..8d7fbcf9b 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/815fdc7/packages/util/src/hex/hasPrefix.ts#L21)* +*Defined in [hex/hasPrefix.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 ad6d767a0..c9dd35ee9 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_hex_stripprefix_.md b/docs/util/modules/_hex_stripprefix_.md index da9bc243c..7aa5a5044 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/815fdc7/packages/util/src/hex/stripPrefix.ts#L23)* +*Defined in [hex/stripPrefix.ts:23](https://github.com/polkadot-js/common/blob/6506c10/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 82853f6be..b595c915c 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_hex_tobn_.md b/docs/util/modules/_hex_tobn_.md index cc120cb9b..464caeca6 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/815fdc7/packages/util/src/hex/toBn.ts#L35)* +*Defined in [hex/toBn.ts:35](https://github.com/polkadot-js/common/blob/6506c10/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 a20a5f90b..7e2524ad3 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: number

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_hex_tonumber_.md b/docs/util/modules/_hex_tonumber_.md index 81cf4b49c..9e9c6007d 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/815fdc7/packages/util/src/hex/toNumber.ts#L21)* +*Defined in [hex/toNumber.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 9a79d75e9..9c1f67918 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_hex_tou8a_.md b/docs/util/modules/_hex_tou8a_.md index 84c08a90c..d7d54c158 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/815fdc7/packages/util/src/hex/toU8a.ts#L24)* +*Defined in [hex/toU8a.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 0d3700c5f..434917f54 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:35:18 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_bn_.md b/docs/util/modules/_is_bn_.md index 369102296..c01f63ade 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/815fdc7/packages/util/src/is/bn.ts#L22)* +*Defined in [is/bn.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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 ff8277904..63be8d48e 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_boolean_.md b/docs/util/modules/_is_boolean_.md index 5e784f588..0010778a2 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/815fdc7/packages/util/src/is/boolean.ts#L19)* +*Defined in [is/boolean.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 cd1785588..e31a5f8ac 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_buffer_.md b/docs/util/modules/_is_buffer_.md index 9c6edfe2b..31477cb39 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/815fdc7/packages/util/src/is/buffer.ts#L21)* +*Defined in [is/buffer.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 72f8581db..897172bbb 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_error_.md b/docs/util/modules/_is_error_.md index 21330e871..08574fb23 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/815fdc7/packages/util/src/is/error.ts#L21)* +*Defined in [is/error.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 86c58502a..84623e5a2 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_function_.md b/docs/util/modules/_is_function_.md index 0292788e1..9e427a022 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/815fdc7/packages/util/src/is/function.ts#L19)* +*Defined in [is/function.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 26cc76f89..1ac6ea3f9 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_is_hex_.md b/docs/util/modules/_is_hex_.md index 2f61dcbfb..57725412b 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/815fdc7/packages/util/src/is/hex.ts#L24)* +*Defined in [is/hex.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 0d997c09d..1a16c885c 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any
clazz any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_instanceof_.md b/docs/util/modules/_is_instanceof_.md index 3f50c5da8..21af29d83 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/815fdc7/packages/util/src/is/instanceOf.ts#L19)* +*Defined in [is/instanceOf.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 4116bf7af..27bb3a13d 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:35:18 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
value string
Optional type IpTypes

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_ip_.md b/docs/util/modules/_is_ip_.md index 36cb6a758..a2158a631 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/815fdc7/packages/util/src/is/ip.ts#L26)* +*Defined in [is/ip.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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 dc658f22d..42c94cf76 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_null_.md b/docs/util/modules/_is_null_.md index 5236fcd00..6f3b8438d 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/815fdc7/packages/util/src/is/null.ts#L19)* +*Defined in [is/null.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 086f7e11f..a1220e3f6 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_number_.md b/docs/util/modules/_is_number_.md index 8ddb5ed86..d3d25e29e 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/815fdc7/packages/util/src/is/number.ts#L19)* +*Defined in [is/number.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 22292b6d6..1345559aa 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:35:18 AM
- +
1
2
3
4

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_object_.md b/docs/util/modules/_is_object_.md index 7bdb10927..f75173129 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/815fdc7/packages/util/src/is/object.ts#L24)* +*Defined in [is/object.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 17dfc756e..e3bddb89c 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_observable_.md b/docs/util/modules/_is_observable_.md index 89f8c54c1..66600223e 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/815fdc7/packages/util/src/is/observable.ts#L26)* +*Defined in [is/observable.ts:26](https://github.com/polkadot-js/common/blob/6506c10/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 8a90cf17d..da2c35366 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_string_.md b/docs/util/modules/_is_string_.md index 0d07fd467..4e3e175e1 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/815fdc7/packages/util/src/is/string.ts#L19)* +*Defined in [is/string.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 141d7de16..eae1f41b4 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_u8a_.md b/docs/util/modules/_is_u8a_.md index 88b04c9fa..03531bfc3 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/815fdc7/packages/util/src/is/u8a.ts#L21)* +*Defined in [is/u8a.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 7358fd508..0b1dec123 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value any

Returns: boolean

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_is_undefined_.md b/docs/util/modules/_is_undefined_.md index f4d23af03..850752fdd 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/815fdc7/packages/util/src/is/undefined.ts#L19)* +*Defined in [is/undefined.ts:19](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/is/undefined.ts#L19)* *__name__*: isUndefined diff --git a/docs/util/modules/_logger_.html b/docs/util/modules/_logger_.html index 496140c1f..9b11281ee 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
_type string

Returns: Logger

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_logger_.md b/docs/util/modules/_logger_.md index a6e07d64b..43f26b8e5 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/815fdc7/packages/util/src/logger.ts#L42)* +*Defined in [logger.ts:42](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/logger.ts#L104)* +*Defined in [logger.ts:104](https://github.com/polkadot-js/common/blob/6506c10/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 6e29b0a68..6c81f5339 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_number_tohex_.md b/docs/util/modules/_number_tohex_.md index a91d2ef31..001810d55 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/815fdc7/packages/util/src/number/toHex.ts#L24)* +*Defined in [number/toHex.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 3039a8774..473c0a15d 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_number_tou8a_.md b/docs/util/modules/_number_tou8a_.md index 71d9c3fd5..c0cc8c208 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/815fdc7/packages/util/src/number/toU8a.ts#L22)* +*Defined in [number/toU8a.ts:22](https://github.com/polkadot-js/common/blob/6506c10/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 de9e21e5d..801e7ef2b 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_polyfill_padend_.html b/docs/util/modules/_polyfill_padend_.html index f539854e6..b617c7cf6 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_polyfill_padstart_.html b/docs/util/modules/_polyfill_padstart_.html index 2e5bd2f1f..091980335 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_polyfill_setprototypeof_.html b/docs/util/modules/_polyfill_setprototypeof_.html index 077b40553..8863ecd00 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_polyfill_textdecoder_.html b/docs/util/modules/_polyfill_textdecoder_.html index f6bc5b1a6..667a6a8ca 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_polyfill_textencoder_.html b/docs/util/modules/_polyfill_textencoder_.html index 59beaa7b4..b1f823b10 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_promisify_.html b/docs/util/modules/_promisify_.html index a2ff90291..1034d52bc 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_promisify_.md b/docs/util/modules/_promisify_.md index 7eabf48e9..89fdff7e4 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/815fdc7/packages/util/src/promisify.ts#L20)* +*Defined in [promisify.ts:20](https://github.com/polkadot-js/common/blob/6506c10/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 1cd1bf99a..935449bf8 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:38:56 PM
- +
Last Updated: 2/13/2019, 5:00:38 PM
+ diff --git a/docs/util/modules/_string_lowerfirst_.html b/docs/util/modules/_string_lowerfirst_.html index 3703daca2..455025717 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_string_lowerfirst_.md b/docs/util/modules/_string_lowerfirst_.md index dc1698a73..19cf9b242 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/815fdc7/packages/util/src/string/lowerFirst.ts#L19)* +*Defined in [string/lowerFirst.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 48152d317..cc1c8ae1d 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_string_shorten_.md b/docs/util/modules/_string_shorten_.md index e7f7dd7de..97478a3e5 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/815fdc7/packages/util/src/string/shorten.ts#L19)* +*Defined in [string/shorten.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 5232134f0..82610940e 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value undefined | string

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_string_tou8a_.md b/docs/util/modules/_string_tou8a_.md index 5dc183200..a08058cb7 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/815fdc7/packages/util/src/string/toU8a.ts#L39)* +*Defined in [string/toU8a.ts:39](https://github.com/polkadot-js/common/blob/6506c10/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 19e7d69aa..4e942d9b7 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value string | null

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_string_upperfirst_.md b/docs/util/modules/_string_upperfirst_.md index 6fa36ca8d..bf3a32452 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/815fdc7/packages/util/src/string/upperFirst.ts#L19)* +*Defined in [string/upperFirst.ts:19](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/string/upperFirst.ts#L19)* *__name__*: stringUpperFirst diff --git a/docs/util/modules/_syncify_.html b/docs/util/modules/_syncify_.html index f9f52bca9..8d233b8bf 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_syncify_.md b/docs/util/modules/_syncify_.md index f0e740b1c..e99554912 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/815fdc7/packages/util/src/syncify.ts#L11)* +*Defined in [syncify.ts:11](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/syncify.ts#L11)* **Parameters:** diff --git a/docs/util/modules/_types_.html b/docs/util/modules/_types_.html index b252d2da4..4e1de6e28 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_types_.md b/docs/util/modules/_types_.md index e44c95f4b..3d5247a61 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/815fdc7/packages/util/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/common/blob/6506c10/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/815fdc7/packages/util/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/types.ts#L13)* ___ diff --git a/docs/util/modules/_u8a_concat_.html b/docs/util/modules/_u8a_concat_.html index 402e0a961..ddbdbeba4 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:35:18 AM
- +
1
2
3
4
5
6

Parameters:

Name Type
Rest _list Array<Uint8Array | string>

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_u8a_concat_.md b/docs/util/modules/_u8a_concat_.md index c64a844f8..1b6a527bb 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/815fdc7/packages/util/src/u8a/concat.ts#L24)* +*Defined in [u8a/concat.ts:24](https://github.com/polkadot-js/common/blob/6506c10/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 e509030b1..853fe0d7e 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_u8a_fixlength_.md b/docs/util/modules/_u8a_fixlength_.md index 292b18885..1d0bee90b 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/815fdc7/packages/util/src/u8a/fixLength.ts#L21)* +*Defined in [u8a/fixLength.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 2ee815f8b..61439b195 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_u8a_tobn_.md b/docs/util/modules/_u8a_tobn_.md index 15360d2f4..0e7cc4ad8 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/815fdc7/packages/util/src/u8a/toBn.ts#L29)* +*Defined in [u8a/toBn.ts:29](https://github.com/polkadot-js/common/blob/6506c10/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 e7289b76b..5fc64b2fb 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: Buffer

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_u8a_tobuffer_.md b/docs/util/modules/_u8a_tobuffer_.md index 4338a27f6..94427ac83 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/815fdc7/packages/util/src/u8a/toBuffer.ts#L19)* +*Defined in [u8a/toBuffer.ts:19](https://github.com/polkadot-js/common/blob/6506c10/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 a93890bb1..7538da3b2 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:35:18 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:50:54 AM
+ diff --git a/docs/util/modules/_u8a_tohex_.md b/docs/util/modules/_u8a_tohex_.md index 03c9fff68..99b3da22b 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/815fdc7/packages/util/src/u8a/toHex.ts#L21)* +*Defined in [u8a/toHex.ts:21](https://github.com/polkadot-js/common/blob/6506c10/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 b9a0b382a..c2a6f1bca 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:35:18 AM
- +
1
2
3

Parameters:

Name Type
Optional value Uint8Array | null

Returns: string

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_u8a_tostring_.md b/docs/util/modules/_u8a_tostring_.md index a7d3899cf..0e88a66a0 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/815fdc7/packages/util/src/u8a/toString.ts#L35)* +*Defined in [u8a/toString.ts:35](https://github.com/polkadot-js/common/blob/6506c10/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 a51869bb1..bd673490c 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:35:18 AM
- +
1
2
3
4

Parameters:

Name Type
Optional value Array<number> | Buffer | Uint8Array | string | null

Returns: Uint8Array

Last Updated: 2/26/2019, 11:50:54 AM
+ diff --git a/docs/util/modules/_u8a_tou8a_.md b/docs/util/modules/_u8a_tou8a_.md index b62344688..345b72a1f 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/815fdc7/packages/util/src/u8a/toU8a.ts#L27)* +*Defined in [u8a/toU8a.ts:27](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/u8a/toU8a.ts#L27)* *__name__*: u8aToU8a diff --git a/lerna.json b/lerna.json index 46e1113d0..be38f57ec 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.34.27" + "version": "0.34.28" } diff --git a/package.json b/package.json index 6b34f1547..c7e13d9cd 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.34.27", + "version": "0.34.28", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/chainspec/package.json b/packages/chainspec/package.json index 36159d75d..58df10f68 100644 --- a/packages/chainspec/package.json +++ b/packages/chainspec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/chainspec", - "version": "0.34.27", + "version": "0.34.28", "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.27" + "@polkadot/util": "^0.34.28" } } diff --git a/packages/db/package.json b/packages/db/package.json index a929b4276..391cba94a 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/db", - "version": "0.34.27", + "version": "0.34.28", "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.27", - "@polkadot/util": "^0.34.27", + "@polkadot/trie-hash": "^0.34.28", + "@polkadot/util": "^0.34.28", "@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 8dc846eaf..43491a046 100644 --- a/packages/keyring/package.json +++ b/packages/keyring/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/keyring", - "version": "0.34.27", + "version": "0.34.28", "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.27", - "@polkadot/util-crypto": "^0.34.27", + "@polkadot/util": "^0.34.28", + "@polkadot/util-crypto": "^0.34.28", "@types/bs58": "^4.0.0", "bs58": "^4.0.1" } diff --git a/packages/trie-codec/package.json b/packages/trie-codec/package.json index 0846f3b6c..9c5f314bd 100644 --- a/packages/trie-codec/package.json +++ b/packages/trie-codec/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-codec", - "version": "0.34.27", + "version": "0.34.28", "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.27" + "@polkadot/util": "^0.34.28" } } diff --git a/packages/trie-db/package.json b/packages/trie-db/package.json index a6c7cc36f..562964695 100644 --- a/packages/trie-db/package.json +++ b/packages/trie-db/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-db", - "version": "0.34.27", + "version": "0.34.28", "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.27", - "@polkadot/trie-codec": "^0.34.27", - "@polkadot/trie-hash": "^0.34.27", - "@polkadot/util": "^0.34.27", - "@polkadot/util-crypto": "^0.34.27" + "@polkadot/db": "^0.34.28", + "@polkadot/trie-codec": "^0.34.28", + "@polkadot/trie-hash": "^0.34.28", + "@polkadot/util": "^0.34.28", + "@polkadot/util-crypto": "^0.34.28" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.27", - "@polkadot/util-rlp": "^0.34.27", + "@polkadot/chainspec": "^0.34.28", + "@polkadot/util-rlp": "^0.34.28", "ethereumjs-testing": "1.0.4" } } diff --git a/packages/trie-hash/package.json b/packages/trie-hash/package.json index 1a00e9171..803494a69 100644 --- a/packages/trie-hash/package.json +++ b/packages/trie-hash/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/trie-hash", - "version": "0.34.27", + "version": "0.34.28", "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.27" + "@polkadot/util": "^0.34.28" }, "devDependencies": { - "@polkadot/chainspec": "^0.34.27" + "@polkadot/chainspec": "^0.34.28" } } diff --git a/packages/util-crypto/package.json b/packages/util-crypto/package.json index 1ea152a2d..63164307d 100644 --- a/packages/util-crypto/package.json +++ b/packages/util-crypto/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-crypto", - "version": "0.34.27", + "version": "0.34.28", "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.27", + "@polkadot/util": "^0.34.28", "@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 3cf2707e0..8a4281a44 100644 --- a/packages/util-rlp/package.json +++ b/packages/util-rlp/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util-rlp", - "version": "0.34.27", + "version": "0.34.28", "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.27" + "@polkadot/util": "^0.34.28" }, "devDependencies": { "ethereumjs-testing": "1.0.4" diff --git a/packages/util/package.json b/packages/util/package.json index 5fc88e2e0..8976995fe 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/util", - "version": "0.34.27", + "version": "0.34.28", "description": "A collection of useful utilities for @polkadot", "main": "index.js", "keywords": [