11 KiB
name: ReferendumInfoExtended
description: A ReferendumInfo with an additional index field
Type parameters
S : ConstructorDef
T : object
V : object
E : object
Hierarchy
ReferendumInfo
↳ ReferendumInfoExtended
Implements
Codec
Constructors
constructor
⊕ new ReferendumInfoExtended(info: ReferendumInfo, index: BN | number): ReferendumInfoExtended
Overrides ReferendumInfo.__constructor
Defined in democracy/referendumInfo.ts:19
Parameters:
| Name | Type |
|---|---|
| info | ReferendumInfo |
| index | BN |
Returns: ReferendumInfoExtended
Properties
__@toStringTag
● __@toStringTag: string
Inherited from Map.[Symbol.toStringTag]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130
size
● size: number
Inherited from Map.size
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28
Accessors
Type
getType(): E
Inherited from Struct.Type
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142
description: Returns the Type description to sthe structure
Returns: E
delay
getdelay(): BlockNumber
Inherited from ReferendumInfo.delay
Defined in /home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:56
description: The delay (in blocks) to wait after a successful referendum before deploying
Returns: BlockNumber
encodedLength
getencodedLength(): number
Inherited from Struct.encodedLength
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149
description: The length of the value when encoded as a Uint8Array
Returns: number
end
getend(): BlockNumber
Inherited from ReferendumInfo.end
Defined in /home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:35
description: When voting on this referendum will end
Returns: BlockNumber
index
getindex(): ReferendumIndex
Defined in democracy/referendumInfo.ts:30
description: Convenience getter, returns the referendumIndex
Returns: ReferendumIndex
proposal
getproposal(): Proposal
Inherited from ReferendumInfo.proposal
Defined in /home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:42
description: The proposal being voted on
Returns: Proposal
threshold
getthreshold(): VoteThreshold
Inherited from ReferendumInfo.threshold
Defined in /home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:49
description: The thresholding mechanism to determine whether it passed
Returns: VoteThreshold
Methods
__@iterator
▸ __@iterator(): IterableIterator<[keyof S, Codec]>
Inherited from Map.[Symbol.iterator]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113
Returns an iterable of entries in the map.
Returns: IterableIterator<[keyof S, Codec]>
clear
▸ clear(): void
Inherited from Map.clear
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns: void
delete
▸ delete(key: keyof S): boolean
Inherited from Map.delete
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
Returns: boolean
entries
▸ entries(): IterableIterator<[keyof S, Codec]>
Inherited from Map.entries
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118
Returns an iterable of key, value pairs for every entry in the map.
Returns: IterableIterator<[keyof S, Codec]>
eq
▸ eq(other?: any): boolean
Inherited from Struct.eq
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158
description: Compares the value of the input to see if there is a match
Parameters:
| Name | Type |
|---|---|
Optional other |
any |
Returns: boolean
forEach
▸ forEach(callbackfn: function, thisArg?: any): void
Inherited from Map.forEach
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters:
| Name | Type |
|---|---|
| callbackfn | function |
Optional thisArg |
any |
Returns: void
get
▸ get(name: keyof S): Codec | undefined
Inherited from Struct.get
Overrides Map.get
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166
description: Returns a specific names entry in the structure
Parameters:
| Name | Type | Description |
|---|---|---|
| name | keyof S |
The name of the entry to retrieve |
Returns: Codec | undefined
getAtIndex
▸ getAtIndex(index: number): Codec
Inherited from Struct.getAtIndex
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173
description: Returns the values of a member at a specific index (Rather use get(name) for performance)
Parameters:
| Name | Type |
|---|---|
| index | number |
Returns: Codec
has
▸ has(key: keyof S): boolean
Inherited from Map.has
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
Returns: boolean
keys
▸ keys(): IterableIterator<keyof S>
Inherited from Map.keys
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123
Returns an iterable of keys in the map
Returns: IterableIterator<keyof S>
set
▸ set(key: keyof S, value: Codec): this
Inherited from Map.set
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
| value | Codec |
Returns: this
toArray
▸ toArray(): Array<Codec>
Inherited from Struct.toArray
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Inherited from Struct.toHex
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Inherited from Struct.toJSON
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:194
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Inherited from Struct.toString
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:208
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Inherited from Struct.toU8a
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:216
description: Encodes the value as a Uint8Array as per the parity-codec specifications
Parameters:
| Name | Type | Description |
|---|---|---|
Optional isBare |
undefined |
false |
Returns: Uint8Array
values
▸ values(): IterableIterator<Codec>
Inherited from Map.values
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128
Returns an iterable of values in the map
Returns: IterableIterator<Codec>
<Static> with
▸ with<S>(Types: S): Constructor<Struct<S>>
Inherited from Struct.with
Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: Constructor<Struct<S>>