Files
api/docs/assets/js/320.bfb36211.js
T
2019-02-27 15:39:51 +00:00

1 line
15 KiB
JavaScript

(window.webpackJsonp=window.webpackJsonp||[]).push([[320],{563:function(e,t,r){"use strict";r.r(t);var s=r(46),o=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": VoteThreshold")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Voting threshold, used inside proposals to set change the voting tally")]),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",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ VoteThreshold")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new VoteThreshold")]),e._v("(index?: "),r("em",[r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[e._v("VoteThreshold")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/type/VoteThreshold.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/VoteThreshold.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[e._v("VoteThreshold")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#encodedlength"}},[e._v("encodedLength")])],1)]),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/Enum.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:64"),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:"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 "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#isempty"}},[e._v("isEmpty")])],1)]),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/Enum.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:71"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value (always false)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),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:"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("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#eq"}},[e._v("eq")])],1)]),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/Enum.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:78"),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:"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("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tohex"}},[e._v("toHex")])],1)]),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/Enum.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:91"),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("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tojson"}},[e._v("toJSON")])],1)]),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/Enum.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),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:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/255b495/packages/types/src/codec/Enum.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),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:"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("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tostring"}},[e._v("toString")])],1)]),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/Enum.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:112"),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("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tou8a"}},[e._v("toU8a")])],1)]),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/Enum.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:120"),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:"decodeenum"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeenum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeenum","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("<Static>")]),e._v(" decodeEnum")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeEnum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#decodeenum"}},[e._v("decodeEnum")])],1)]),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/Enum.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:47"),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("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]);