quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.45.1

Browse Source
This commit is contained in:
Travis CI
2019-02-19 12:53:41 +00:00
parent f807a93e87
commit f57a6b1533
344 changed files with 5376 additions and 3174 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md
+34 -20
View File
@@ -25,18 +25,17 @@
## constructor
⊕ **new ReferendumInfoExtended**(info: *`ReferendumInfo`*, index: *`BN` \| `number`*): [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md)
⊕ **new ReferendumInfoExtended**(info: *`any`*): [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md)
*Overrides ReferendumInfo.__constructor*
*Defined in [democracy/referendumInfo.ts:19](https://github.com/polkadot-js/api/blob/cf5ca51/packages/api-derive/src/democracy/referendumInfo.ts#L19)*
*Defined in [democracy/referendumInfo.ts:18](https://github.com/polkadot-js/api/blob/f807a93/packages/api-derive/src/democracy/referendumInfo.ts#L18)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| info | `ReferendumInfo` |
| index | `BN` \| `number` |
| info | `any` |
**Returns:** [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md)
@@ -77,7 +76,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L145)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L160)*
*__description__*: Returns the Type description to sthe structure
@@ -92,7 +91,7 @@ getdelay(): `BlockNumber`
*Inherited from ReferendumInfo.delay*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/type/ReferendumInfo.ts#L56)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/type/ReferendumInfo.ts#L56)*
*__description__*: The delay (in blocks) to wait after a successful referendum before deploying
@@ -107,7 +106,7 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L152)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L167)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -122,7 +121,7 @@ getend(): `BlockNumber`
*Inherited from ReferendumInfo.end*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/type/ReferendumInfo.ts#L35)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/type/ReferendumInfo.ts#L35)*
*__description__*: When voting on this referendum will end
@@ -135,12 +134,27 @@ ___
getindex(): `ReferendumIndex`
*Defined in [democracy/referendumInfo.ts:30](https://github.com/polkadot-js/api/blob/cf5ca51/packages/api-derive/src/democracy/referendumInfo.ts#L30)*
*Defined in [democracy/referendumInfo.ts:28](https://github.com/polkadot-js/api/blob/f807a93/packages/api-derive/src/democracy/referendumInfo.ts#L28)*
*__description__*: Convenience getter, returns the referendumIndex
**Returns:** `ReferendumIndex`
___
<a id="isempty"></a>
## isEmpty
getisEmpty(): `boolean`
*Inherited from Struct.isEmpty*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Checks if the value is an empty value
**Returns:** `boolean`
___
<a id="proposal"></a>
@@ -150,7 +164,7 @@ getproposal(): `Proposal`
*Inherited from ReferendumInfo.proposal*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/type/ReferendumInfo.ts#L42)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/type/ReferendumInfo.ts#L42)*
*__description__*: The proposal being voted on
@@ -165,7 +179,7 @@ getthreshold(): `VoteThreshold`
*Inherited from ReferendumInfo.threshold*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/type/ReferendumInfo.ts#L49)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/type/ReferendumInfo.ts#L49)*
*__description__*: The thresholding mechanism to determine whether it passed
@@ -245,7 +259,7 @@ ___
*Inherited from Struct.eq*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:161](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L161)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L176)*
*__description__*: Compares the value of the input to see if there is a match
@@ -288,7 +302,7 @@ ___
*Overrides Map.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:169](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L169)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L184)*
*__description__*: Returns a specific names entry in the structure
@@ -309,7 +323,7 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L176)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L191)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -384,7 +398,7 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:183](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L183)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L198)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -399,7 +413,7 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:190](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L190)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L205)*
*__description__*: Returns a hex string representation of the value
@@ -414,7 +428,7 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:197](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L197)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L212)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -429,7 +443,7 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:211](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L211)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L226)*
*__description__*: Returns the string representation of the value
@@ -444,7 +458,7 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:219](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L219)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L234)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -480,7 +494,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/cf5ca51/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/f807a93/packages/types/src/codec/Struct.ts#L125)*
**Type parameters:**