1 line
26 KiB
JavaScript
1 line
26 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{694: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("p",[a("em",[a("strong",[t._v("name")])]),t._v(": Struct")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": A Struct defines an Object with key/values - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order.")]),t._v(" "),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:"s-constructordef"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),a("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),a("h4",{attrs:{id:"t-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),a("code",[t._v("object")])]),t._v(" "),a("h4",{attrs:{id:"v-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),a("code",[t._v("object")])]),t._v(" "),a("h4",{attrs:{id:"e-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),a("code",[t._v("object")])]),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("code",[t._v("Map")]),t._v("<"),a("code",[t._v("keyof S")]),t._v(", "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("↳ Struct")])]),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_health_.health.html"}},[t._v("Health")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],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:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],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 Struct")]),t._v("(Types: "),a("em",[a("code",[t._v("S")])]),t._v(", value?: "),a("em",[a("code",[t._v("V")]),t._v(" | "),a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("any")]),t._v(", "),a("code",[t._v("any")]),t._v("> | "),a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(", jsonMap?: "),a("em",[a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("keyof S")]),t._v(", "),a("code",[t._v("string")]),t._v(">")]),t._v("): "),a("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:31"),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("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("Types")]),t._v(" "),a("td",[a("code",[t._v("S")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("V")]),t._v(" | "),a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("any")]),t._v(", "),a("code",[t._v("any")]),t._v("> | "),a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("td",[t._v("{} as V")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" jsonMap")]),t._v(" "),a("td",[a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("keyof S")]),t._v(", "),a("code",[t._v("string")]),t._v(">")]),t._v(" "),a("td",[t._v("new Map()")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),a("p",[a("a",{attrs:{id:"map"}})]),t._v(" "),a("h2",{attrs:{id:"static-map"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-map","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("<Static>")]),t._v(" Map")]),t._v(" "),a("p",[a("strong",[t._v("● Map")]),t._v(": "),a("em",[a("code",[t._v("MapConstructor")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36")])]),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:"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("code",[t._v("E")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("E")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"encodedlength"}})]),t._v(" "),a("h2",{attrs:{id:"encodedlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),a("p",[a("strong",[t._v("get encodedLength")]),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/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("number")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isempty"}})]),t._v(" "),a("h2",{attrs:{id:"isempty"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),a("p",[a("strong",[t._v("get isEmpty")]),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/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),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:"eq"}})]),t._v(" "),a("h2",{attrs:{id:"eq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("eq")]),t._v("(other?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),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(" other")]),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"),t._v(" "),a("p",[a("a",{attrs:{id:"get"}})]),t._v(" "),a("h2",{attrs:{id:"get"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("get")]),t._v("(name: "),a("em",[a("code",[t._v("keyof S")])]),t._v("): "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),a("code",[t._v("undefined")])],1),t._v(" "),a("p",[a("em",[t._v("Overrides Map.get")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),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("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("name")]),t._v(" "),a("td",[a("code",[t._v("keyof S")])]),t._v(" "),a("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),a("code",[t._v("undefined")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"getatindex"}})]),t._v(" "),a("h2",{attrs:{id:"getatindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("getAtIndex")]),t._v("(index: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),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("index")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"toarray"}})]),t._v(" "),a("h2",{attrs:{id:"toarray"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toArray")]),t._v("(): "),a("code",[t._v("Array")]),t._v("<"),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),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/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Array")]),t._v("<"),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tohex"}})]),t._v(" "),a("h2",{attrs:{id:"tohex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toHex")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),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:"tojson"}})]),t._v(" "),a("h2",{attrs:{id:"tojson"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toJSON")]),t._v("(): "),a("code",[t._v("any")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("any")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tostring"}})]),t._v(" "),a("h2",{attrs:{id:"tostring"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("toString")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),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:"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("(isBare?: "),a("em",[a("code",[t._v("undefined")]),t._v(" | "),a("code",[t._v("false")]),t._v(" | "),a("code",[t._v("true")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),a("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),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("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),a("td",[a("code",[t._v("undefined")]),t._v(" | "),a("code",[t._v("false")]),t._v(" | "),a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"with"}})]),t._v(" "),a("h2",{attrs:{id:"static-with"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("<Static>")]),t._v(" with")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("with")]),t._v("<"),a("code",[t._v("S")]),t._v(">(Types: "),a("em",[a("code",[t._v("S")])]),t._v("): "),a("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),a("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),a("code",[t._v("S")]),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/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Type parameters:")])]),t._v(" "),a("h4",{attrs:{id:"s-constructordef-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),a("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],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("Types")]),t._v(" "),a("td",[a("code",[t._v("S")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),a("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),a("code",[t._v("S")]),t._v(">>")],1),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); |