1 line
40 KiB
JavaScript
1 line
40 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{709: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:"type-parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),a("h4",{attrs:{id:"codecresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),a("h4",{attrs:{id:"subscriptionresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),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("ApiBase")])]),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("h1",{attrs:{id:"implements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),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 ApiBase")]),t._v("(provider?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(", type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:81"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Create an instance of the 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(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),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(" api "),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("Api")]),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("isReady")]),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\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),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 punctuation"}},[t._v("{")]),t._v("\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("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),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("}")]),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("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(" provider")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("{}")])]),t._v(" "),a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"accessors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),a("p",[a("a",{attrs:{id:"derive"}})]),t._v(" "),a("h2",{attrs:{id:"derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),a("p",[a("strong",[t._v("get derive")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'best number'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),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("}")]),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("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"genesishash"}})]),t._v(" "),a("h2",{attrs:{id:"genesishash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),a("p",[a("strong",[t._v("get genesisHash")]),t._v("(): "),a("code",[t._v("Hash")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Hash")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"hassubscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),a("p",[a("strong",[t._v("get hasSubscriptions")]),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/api/blob/73a5ea1/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),a("h2",{attrs:{id:"libraryinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),a("p",[a("strong",[t._v("get libraryInfo")]),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/api/blob/73a5ea1/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"query"}})]),t._v(" "),a("h2",{attrs:{id:"query"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),a("p",[a("strong",[t._v("get query")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[t._v("All calls inside the namespace, is denoted by "),a("code",[t._v("section")]),t._v("."),a("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),a("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),a("code",[t._v("api.query.system.accountNonce(<accountId>)")]),t._v(" (retrieving the associated nonce for an account), takes the "),a("code",[t._v("AccountId")]),t._v(" as a parameter.")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),a("span",{pre:!0,attrs:{class:"token operator"}},[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("balance"),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'new balance'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),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("}")]),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("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpc"}})]),t._v(" "),a("h2",{attrs:{id:"rpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),a("p",[a("strong",[t._v("get rpc")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),a("code",[t._v("api.query")]),t._v(" and "),a("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),a("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'new header'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),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("}")]),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("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),a("h2",{attrs:{id:"runtimemetadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeMetadata")]),t._v("(): "),a("code",[t._v("Metadata")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Metadata")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),a("h2",{attrs:{id:"runtimeversion"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeVersion")]),t._v("(): "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tx"}})]),t._v(" "),a("h2",{attrs:{id:"tx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),a("p",[a("strong",[t._v("get tx")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),a("span",{pre:!0,attrs:{class:"token operator"}},[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("balance"),a("span",{pre:!0,attrs:{class:"token operator"}},[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(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),a("span",{pre:!0,attrs:{class:"token operator"}},[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 punctuation"}},[t._v("{")]),t._v("status"),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'tx status'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),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 "),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("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"type"}})]),t._v(" "),a("h2",{attrs:{id:"type"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),a("p",[a("strong",[t._v("get type")]),t._v("(): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],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:"disconnect"}})]),t._v(" "),a("h2",{attrs:{id:"disconnect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("disconnect")]),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/api/blob/73a5ea1/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"on"}})]),t._v(" "),a("h2",{attrs:{id:"on"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("on")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'API has been connected to the endpoint'")]),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("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'API has been disconnected from the endpoint'")]),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("}")]),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("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("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"once"}})]),t._v(" "),a("h2",{attrs:{id:"once"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("once")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),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",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'API has been connected to the endpoint'")]),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("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),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 punctuation"}},[t._v("{")]),t._v("\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 string"}},[t._v("'API has been disconnected from the endpoint'")]),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("}")]),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("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("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"registertypes"}})]),t._v(" "),a("h2",{attrs:{id:"registertypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("registerTypes")]),t._v("(types?: "),a("em",[a("code",[t._v("RegistryTypes")])]),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/api/blob/73a5ea1/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),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(" types")]),t._v(" "),a("td",[a("code",[t._v("RegistryTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"setsigner"}})]),t._v(" "),a("h2",{attrs:{id:"setsigner"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("setSigner")]),t._v("(signer: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],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/api/blob/73a5ea1/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),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("signer")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],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);s.default=n.exports}}]); |