Files
api/docs/api-observable/classes/_classes_.rxreferendum.md
T
2018-10-18 14:37:53 +00:00

5.5 KiB

Type parameters

S

T

V

E

Hierarchy

Struct

↳ RxReferendum

Constructors

constructor

⊕ new RxReferendum(value: Tuple, id: * ReferendumIndex | BN | number*): RxReferendum

Overrides Struct.__constructor

Defined in classes.ts:48

Parameters:

Param Type
value Tuple
id ReferendumIndex | BN | number

Returns: RxReferendum


Properties

raw

● raw: T

Inherited from Base.raw

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19


Accessors

Type

getType(): E

Inherited from Struct.Type

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:113

Returns: E


blockNumber

getblockNumber(): BlockNumber

Defined in classes.ts:58

Returns: BlockNumber


encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

Overrides Base.encodedLength

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:117

Returns: number


id

getid(): ReferendumIndex

Defined in classes.ts:62

Returns: ReferendumIndex


proposal

getproposal(): Proposal

Defined in classes.ts:66

Returns: Proposal


voteThreshold

getvoteThreshold(): VoteThreshold

Defined in classes.ts:70

Returns: VoteThreshold


Methods

getAtIndex

▸ getAtIndex(index: number): Base

Inherited from Struct.getAtIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:123

Parameters:

Param Type
index number

Returns: Base


keys

▸ keys(): Array<string>

Inherited from Struct.keys

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138

Returns: Array<string>


toJSON

▸ toJSON(): any

Inherited from Struct.toJSON

Overrides Base.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:127

Returns: any


toString

▸ toString(): string

Inherited from Struct.toString

Overrides Base.toString

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:150

Returns: string


toU8a

▸ toU8a(isBare?: * undefined | false | true*): Uint8Array

Inherited from Struct.toU8a

Overrides Base.toU8a

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142

Parameters:

Param Type
Optional isBare undefined | false | true

Returns: Uint8Array


values

▸ values(): Array<Base>

Inherited from Struct.values

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159

Returns: Array<Base>


<Static> decodeStruct

▸ decodeStruct<S,V,T>(Types: S, value: any, jsonMap: Map<keyof S, string>): T

Inherited from Struct.decodeStruct

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:44

Type parameters:

S

V

T

Parameters:

Param Type
Types S
value any
jsonMap Map<keyof S, string>

Returns: T


<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:103

Type parameters:

S

Parameters:

Param Type
Types S

Returns: Constructor<Struct<S>>