1 line
31 KiB
JavaScript
1 line
31 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{718:function(e,t,r){"use strict";r.r(t);var a=r(46),v=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("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ReferendumInfoExtended")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A [[ReferendumInfo]] with an additional "),r("code",[e._v("index")]),e._v(" field")]),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("ConstructorDef")])]),e._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("code",[e._v("object")])]),e._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[e._v("#")]),e._v(" V : "),r("code",[e._v("object")])]),e._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[e._v("#")]),e._v(" E : "),r("code",[e._v("object")])]),e._v(" "),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("code",[e._v("ReferendumInfo")])]),e._v(" "),r("p",[r("strong",[e._v("↳ ReferendumInfoExtended")])]),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("code",[e._v("Codec")])])]),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 ReferendumInfoExtended")]),e._v("(value: "),r("em",[r("code",[e._v("ReferendumInfo")]),e._v(" | "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1),e._v(", index?: "),r("em",[r("code",[e._v("BN")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides ReferendumInfo.__constructor")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:20"),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("ReferendumInfo")]),e._v(" | "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1)]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("BN")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],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:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),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",[r("strong",[e._v("● size")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.size")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),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:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("E")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.Type")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the Type description to sthe structure")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("E")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"delay"}})]),e._v(" "),r("h2",{attrs:{id:"delay"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delay","aria-hidden":"true"}},[e._v("#")]),e._v(" delay")]),e._v(" "),r("p",[r("strong",[e._v("get delay")]),e._v("(): "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.delay")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The delay (in blocks) to wait after a successful referendum before deploying")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("hr"),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("Inherited from Struct.encodedLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),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:"end"}})]),e._v(" "),r("h2",{attrs:{id:"end"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#end","aria-hidden":"true"}},[e._v("#")]),e._v(" end")]),e._v(" "),r("p",[r("strong",[e._v("get end")]),e._v("(): "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.end")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": When voting on this referendum will end")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("ReferendumIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:33"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Convenience getter, returns the referendumIndex")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("ReferendumIndex")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.isEmpty")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),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:"proposal"}})]),e._v(" "),r("h2",{attrs:{id:"proposal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#proposal","aria-hidden":"true"}},[e._v("#")]),e._v(" proposal")]),e._v(" "),r("p",[r("strong",[e._v("get proposal")]),e._v("(): "),r("code",[e._v("Proposal")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.proposal")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The proposal being voted on")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Proposal")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"threshold"}})]),e._v(" "),r("h2",{attrs:{id:"threshold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#threshold","aria-hidden":"true"}},[e._v("#")]),e._v(" threshold")]),e._v(" "),r("p",[r("strong",[e._v("get threshold")]),e._v("(): "),r("code",[e._v("VoteThreshold")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.threshold")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/ReferendumInfo.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The thresholding mechanism to determine whether it passed")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("VoteThreshold")])]),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:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),e._v(" "),r("p",[e._v("Returns an iterable of entries in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),e._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[e._v("#")]),e._v(" clear")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("clear")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.clear")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),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:"delete"}})]),e._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[e._v("#")]),e._v(" delete")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("delete")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.delete")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),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("keyof S")])])])])]),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:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.eq")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),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(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),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:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),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("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),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("(name: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.get")])]),e._v(" "),r("p",[r("em",[e._v("Overrides Map.get")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a specific names entry in the structure")]),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("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("name")]),e._v(" "),r("td",[r("code",[e._v("keyof S")])]),e._v(" "),r("td",[e._v("The name of the entry to retrieve")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),e._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[e._v("#")]),e._v(" getAtIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAtIndex")]),e._v("(index: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Codec")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.getAtIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),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("index")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Codec")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),e._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[e._v("#")]),e._v(" has")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("has")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.has")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),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("keyof S")])])])])]),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:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("keyof S")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("keyof S")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v(", value: "),r("em",[r("code",[e._v("Codec")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),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("keyof S")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Codec")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toArray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toHex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Overrides Struct.toJSON")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/api-derive/src/democracy/referendumInfo.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Creates the JSON representation")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),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("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toU8a")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),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("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),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:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("<Static>")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("Constructor")]),e._v("<"),r("code",[e._v("Struct")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.with")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("ConstructorDef")])]),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("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Constructor")]),e._v("<"),r("code",[e._v("Struct")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); |