444 lines
9.2 KiB
Markdown
444 lines
9.2 KiB
Markdown
|
|
|
|
# Type parameters
|
|
#### S : `ConstructorDef`
|
|
#### T : `object`
|
|
#### V : `object`
|
|
#### E : `object`
|
|
# Hierarchy
|
|
|
|
`Struct`
|
|
|
|
**↳ RxReferendum**
|
|
|
|
# Implements
|
|
|
|
* `Codec`
|
|
|
|
# Constructors
|
|
|
|
<a id="constructor"></a>
|
|
|
|
## constructor
|
|
|
|
⊕ **new RxReferendum**(value: *`Tuple`*, id: * `ReferendumIndex` | `BN` | `number`*): [RxReferendum](_classes_.rxreferendum.md)
|
|
|
|
*Overrides Struct.__constructor*
|
|
|
|
*Defined in [classes.ts:55](https://github.com/polkadot-js/api/blob/51751d0/packages/api-observable/src/classes.ts#L55)*
|
|
|
|
**Parameters:**
|
|
|
|
| Name | Type |
|
|
| ------ | ------ |
|
|
| value | `Tuple` |
|
|
| id | `ReferendumIndex` | `BN` | `number`|
|
|
|
|
**Returns:** [RxReferendum](_classes_.rxreferendum.md)
|
|
|
|
___
|
|
|
|
# Properties
|
|
|
|
<a id="___tostringtag"></a>
|
|
|
|
## __@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*
|
|
|
|
___
|
|
<a id="size"></a>
|
|
|
|
## 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
|
|
|
|
<a id="type"></a>
|
|
|
|
## Type
|
|
|
|
getType(): `E`
|
|
|
|
*Inherited from Struct.Type*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L142)*
|
|
|
|
*__description__*: Returns the Type description to sthe structure
|
|
|
|
**Returns:** `E`
|
|
|
|
___
|
|
<a id="blocknumber"></a>
|
|
|
|
## blockNumber
|
|
|
|
getblockNumber(): `BlockNumber`
|
|
|
|
*Defined in [classes.ts:65](https://github.com/polkadot-js/api/blob/51751d0/packages/api-observable/src/classes.ts#L65)*
|
|
|
|
**Returns:** `BlockNumber`
|
|
|
|
___
|
|
<a id="encodedlength"></a>
|
|
|
|
## encodedLength
|
|
|
|
getencodedLength(): `number`
|
|
|
|
*Inherited from Struct.encodedLength*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L149)*
|
|
|
|
*__description__*: The length of the value when encoded as a Uint8Array
|
|
|
|
**Returns:** `number`
|
|
|
|
___
|
|
<a id="id"></a>
|
|
|
|
## id
|
|
|
|
getid(): `ReferendumIndex`
|
|
|
|
*Defined in [classes.ts:69](https://github.com/polkadot-js/api/blob/51751d0/packages/api-observable/src/classes.ts#L69)*
|
|
|
|
**Returns:** `ReferendumIndex`
|
|
|
|
___
|
|
<a id="proposal"></a>
|
|
|
|
## proposal
|
|
|
|
getproposal(): `Proposal`
|
|
|
|
*Defined in [classes.ts:73](https://github.com/polkadot-js/api/blob/51751d0/packages/api-observable/src/classes.ts#L73)*
|
|
|
|
**Returns:** `Proposal`
|
|
|
|
___
|
|
<a id="votethreshold"></a>
|
|
|
|
## voteThreshold
|
|
|
|
getvoteThreshold(): `VoteThreshold`
|
|
|
|
*Defined in [classes.ts:77](https://github.com/polkadot-js/api/blob/51751d0/packages/api-observable/src/classes.ts#L77)*
|
|
|
|
**Returns:** `VoteThreshold`
|
|
|
|
___
|
|
|
|
# Methods
|
|
|
|
<a id="___iterator"></a>
|
|
|
|
## __@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`]>
|
|
|
|
___
|
|
<a id="clear"></a>
|
|
|
|
## 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`
|
|
|
|
___
|
|
<a id="delete"></a>
|
|
|
|
## 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`
|
|
|
|
___
|
|
<a id="entries"></a>
|
|
|
|
## 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`]>
|
|
|
|
___
|
|
<a id="foreach"></a>
|
|
|
|
## 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`
|
|
|
|
___
|
|
<a id="get"></a>
|
|
|
|
## 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:159](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L159)*
|
|
|
|
*__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`
|
|
|
|
___
|
|
<a id="getatindex"></a>
|
|
|
|
## getAtIndex
|
|
|
|
▸ **getAtIndex**(index: *`number`*): `Codec`
|
|
|
|
*Inherited from Struct.getAtIndex*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L166)*
|
|
|
|
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
|
|
|
|
**Parameters:**
|
|
|
|
| Name | Type |
|
|
| ------ | ------ |
|
|
| index | `number` |
|
|
|
|
**Returns:** `Codec`
|
|
|
|
___
|
|
<a id="has"></a>
|
|
|
|
## 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`
|
|
|
|
___
|
|
<a id="keys"></a>
|
|
|
|
## 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`>
|
|
|
|
___
|
|
<a id="set"></a>
|
|
|
|
## 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`
|
|
|
|
___
|
|
<a id="toarray"></a>
|
|
|
|
## toArray
|
|
|
|
▸ **toArray**(): `Array`<`Codec`>
|
|
|
|
*Inherited from Struct.toArray*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L173)*
|
|
|
|
*__description__*: Converts the Object to an standard JavaScript Array
|
|
|
|
**Returns:** `Array`<`Codec`>
|
|
|
|
___
|
|
<a id="tohex"></a>
|
|
|
|
## toHex
|
|
|
|
▸ **toHex**(): `string`
|
|
|
|
*Inherited from Struct.toHex*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L180)*
|
|
|
|
*__description__*: Returns a hex string representation of the value
|
|
|
|
**Returns:** `string`
|
|
|
|
___
|
|
<a id="tojson"></a>
|
|
|
|
## toJSON
|
|
|
|
▸ **toJSON**(): `any`
|
|
|
|
*Inherited from Struct.toJSON*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L187)*
|
|
|
|
*__description__*: Converts the Object to JSON, typically used for RPC transfers
|
|
|
|
**Returns:** `any`
|
|
|
|
___
|
|
<a id="tostring"></a>
|
|
|
|
## toString
|
|
|
|
▸ **toString**(): `string`
|
|
|
|
*Inherited from Struct.toString*
|
|
|
|
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L201)*
|
|
|
|
*__description__*: Returns the string representation of the value
|
|
|
|
**Returns:** `string`
|
|
|
|
___
|
|
<a id="tou8a"></a>
|
|
|
|
## 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:209](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L209)*
|
|
|
|
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
|
|
|
|
**Parameters:**
|
|
|
|
| Name | Type | Description |
|
|
| ------ | ------ | ------ |
|
|
| `Optional` isBare | `undefined` | `false` | `true`| true when the value has none of the type-specific prefixes (internal) |
|
|
|
|
**Returns:** `Uint8Array`
|
|
|
|
___
|
|
<a id="values"></a>
|
|
|
|
## 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`>
|
|
|
|
___
|
|
<a id="with"></a>
|
|
|
|
## `<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](https://github.com/polkadot-js/api/blob/51751d0/packages/types/src/codec/Struct.ts#L122)*
|
|
|
|
**Type parameters:**
|
|
|
|
#### S : `ConstructorDef`
|
|
**Parameters:**
|
|
|
|
| Name | Type |
|
|
| ------ | ------ |
|
|
| Types | `S` |
|
|
|
|
**Returns:** `Constructor`<`Struct`<`S`>>
|
|
|
|
___
|
|
|