[CI Skip] 0.42.7
This commit is contained in:
@@ -17,6 +17,8 @@
|
||||
* ["chain/index"](modules/_chain_index_.md)
|
||||
* ["chain/subscribeNewHead"](modules/_chain_subscribenewhead_.md)
|
||||
* ["democracy/index"](modules/_democracy_index_.md)
|
||||
* ["democracy/referendumInfo"](modules/_democracy_referenduminfo_.md)
|
||||
* [ReferendumInfoExtended](classes/_democracy_referenduminfo_.referenduminfoextended.md)
|
||||
* ["democracy/referendumInfos"](modules/_democracy_referenduminfos_.md)
|
||||
* ["democracy/referendumVotesFor"](modules/_democracy_referendumvotesfor_.md)
|
||||
* ["democracy/referendums"](modules/_democracy_referendums_.md)
|
||||
|
||||
@@ -0,0 +1,497 @@
|
||||
|
||||
|
||||
*__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
|
||||
|
||||
<a id="constructor"></a>
|
||||
|
||||
## constructor
|
||||
|
||||
⊕ **new ReferendumInfoExtended**(info: *`ReferendumInfo`*, index: *`BN` | `number`*): [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md)
|
||||
|
||||
*Overrides ReferendumInfo.__constructor*
|
||||
|
||||
*Defined in [democracy/referendumInfo.ts:19](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendumInfo.ts#L19)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| info | `ReferendumInfo` |
|
||||
| index | `BN` | `number` |
|
||||
|
||||
**Returns:** [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.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/b40d7a3/packages/types/src/codec/Struct.ts#L142)*
|
||||
|
||||
*__description__*: Returns the Type description to sthe structure
|
||||
|
||||
**Returns:** `E`
|
||||
|
||||
___
|
||||
<a id="delay"></a>
|
||||
|
||||
## delay
|
||||
|
||||
getdelay(): `BlockNumber`
|
||||
|
||||
*Inherited from ReferendumInfo.delay*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/ReferendumInfo.ts#L56)*
|
||||
|
||||
*__description__*: The delay (in blocks) to wait after a successful referendum before deploying
|
||||
|
||||
**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/b40d7a3/packages/types/src/codec/Struct.ts#L149)*
|
||||
|
||||
*__description__*: The length of the value when encoded as a Uint8Array
|
||||
|
||||
**Returns:** `number`
|
||||
|
||||
___
|
||||
<a id="end"></a>
|
||||
|
||||
## end
|
||||
|
||||
getend(): `BlockNumber`
|
||||
|
||||
*Inherited from ReferendumInfo.end*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/ReferendumInfo.ts#L35)*
|
||||
|
||||
*__description__*: When voting on this referendum will end
|
||||
|
||||
**Returns:** `BlockNumber`
|
||||
|
||||
___
|
||||
<a id="index"></a>
|
||||
|
||||
## index
|
||||
|
||||
getindex(): `ReferendumIndex`
|
||||
|
||||
*Defined in [democracy/referendumInfo.ts:30](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendumInfo.ts#L30)*
|
||||
|
||||
*__description__*: Convenience getter, returns the referendumIndex
|
||||
|
||||
**Returns:** `ReferendumIndex`
|
||||
|
||||
___
|
||||
<a id="proposal"></a>
|
||||
|
||||
## proposal
|
||||
|
||||
getproposal(): `Proposal`
|
||||
|
||||
*Inherited from ReferendumInfo.proposal*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/ReferendumInfo.ts#L42)*
|
||||
|
||||
*__description__*: The proposal being voted on
|
||||
|
||||
**Returns:** `Proposal`
|
||||
|
||||
___
|
||||
<a id="threshold"></a>
|
||||
|
||||
## threshold
|
||||
|
||||
getthreshold(): `VoteThreshold`
|
||||
|
||||
*Inherited from ReferendumInfo.threshold*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/ReferendumInfo.ts#L49)*
|
||||
|
||||
*__description__*: The thresholding mechanism to determine whether it passed
|
||||
|
||||
**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="eq"></a>
|
||||
|
||||
## eq
|
||||
|
||||
▸ **eq**(other?: *`any`*): `boolean`
|
||||
|
||||
*Inherited from Struct.eq*
|
||||
|
||||
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L158)*
|
||||
|
||||
*__description__*: Compares the value of the input to see if there is a match
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| `Optional` other | `any` |
|
||||
|
||||
**Returns:** `boolean`
|
||||
|
||||
___
|
||||
<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:166](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L166)*
|
||||
|
||||
*__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:173](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L173)*
|
||||
|
||||
*__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:180](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L180)*
|
||||
|
||||
*__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:187](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L187)*
|
||||
|
||||
*__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:194](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L194)*
|
||||
|
||||
*__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:208](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L208)*
|
||||
|
||||
*__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:216](https://github.com/polkadot-js/api/blob/b40d7a3/packages/types/src/codec/Struct.ts#L216)*
|
||||
|
||||
*__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/b40d7a3/packages/types/src/codec/Struct.ts#L122)*
|
||||
|
||||
**Type parameters:**
|
||||
|
||||
#### S : `ConstructorDef`
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| Types | `S` |
|
||||
|
||||
**Returns:** `Constructor`<`Struct`<`S`>>
|
||||
|
||||
___
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
**● accounts**: *`ReturnTypes`<["accounts/index"](../modules/_accounts_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L27)*
|
||||
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L27)*
|
||||
|
||||
___
|
||||
<a id="balances"></a>
|
||||
@@ -21,7 +21,7 @@ ___
|
||||
|
||||
**● balances**: *`ReturnTypes`<["balances/index"](../modules/_balances_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L28)*
|
||||
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L28)*
|
||||
|
||||
___
|
||||
<a id="chain"></a>
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
**● chain**: *`ReturnTypes`<["chain/index"](../modules/_chain_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L29)*
|
||||
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L29)*
|
||||
|
||||
___
|
||||
<a id="democracy"></a>
|
||||
@@ -39,7 +39,7 @@ ___
|
||||
|
||||
**● democracy**: *`ReturnTypes`<["democracy/index"](../modules/_democracy_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L30)*
|
||||
*Defined in [index.ts:30](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L30)*
|
||||
|
||||
___
|
||||
<a id="session"></a>
|
||||
@@ -48,7 +48,7 @@ ___
|
||||
|
||||
**● session**: *`ReturnTypes`<["session/index"](../modules/_session_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L31)*
|
||||
*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L31)*
|
||||
|
||||
___
|
||||
<a id="staking"></a>
|
||||
@@ -57,7 +57,7 @@ ___
|
||||
|
||||
**● staking**: *`ReturnTypes`<["staking/index"](../modules/_staking_index_.md)>*
|
||||
|
||||
*Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L32)*
|
||||
*Defined in [index.ts:32](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L32)*
|
||||
|
||||
___
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ AccountIdAndIndex**: *[`undefined` | `AccountId`, `undefined` | `AccountIndex`]*
|
||||
|
||||
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
|
||||
*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/idAndIndex.ts#L16)*
|
||||
|
||||
___
|
||||
|
||||
@@ -20,7 +20,7 @@ ___
|
||||
|
||||
▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
|
||||
*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/idAndIndex.ts#L18)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/idToIndex.ts#L13)*
|
||||
*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/idToIndex.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ AccountIndexes**: *`object`*
|
||||
|
||||
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/indexes.ts#L13)*
|
||||
*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/indexes.ts#L13)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/indexes.ts#L15)*
|
||||
*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/indexes.ts#L15)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/accounts/indexToId.ts#L14)*
|
||||
*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/accounts/indexToId.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/fees.ts#L13)*
|
||||
*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/fees.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/validatingBalance.ts#L16)*
|
||||
*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/validatingBalance.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/validatingBalances.ts#L14)*
|
||||
*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/validatingBalances.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/votingBalance.ts#L16)*
|
||||
*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/votingBalance.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/votingBalances.ts#L13)*
|
||||
*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/votingBalances.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)*
|
||||
*Defined in [balances/votingBalancesNominatorsFor.ts:16](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L16)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/bestNumber.ts#L23)*
|
||||
*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/bestNumber.ts#L23)*
|
||||
|
||||
*__description__*: Get the latest block number.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
|
||||
*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
|
||||
|
||||
*__description__*: Get the latest finalised block number. example
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
|
||||
*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
|
||||
|
||||
*__description__*: Calculates the lag between finalised head and best head
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/getHeader.ts#L25)*
|
||||
*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/getHeader.ts#L25)*
|
||||
|
||||
*__description__*: Get the a specific block header and extend it with the author
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]*
|
||||
|
||||
*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/subscribeNewHead.ts#L13)*
|
||||
*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/subscribeNewHead.ts#L13)*
|
||||
|
||||
___
|
||||
|
||||
@@ -20,7 +20,7 @@ ___
|
||||
|
||||
▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/chain/subscribeNewHead.ts#L26)*
|
||||
*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/chain/subscribeNewHead.ts#L26)*
|
||||
|
||||
*__description__*: Subscribe to block headers and extend it with the author
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
### Classes
|
||||
|
||||
* [ReferendumInfoExtended](../classes/_democracy_referenduminfo_.referenduminfoextended.md)
|
||||
|
||||
### Functions
|
||||
|
||||
* [referendumInfo](_democracy_referenduminfo_.md#referenduminfo)
|
||||
|
||||
---
|
||||
|
||||
# Functions
|
||||
|
||||
<a id="referenduminfo"></a>
|
||||
|
||||
## referendumInfo
|
||||
|
||||
▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendumInfo.ts:35](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendumInfo.ts#L35)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
| Name | Type |
|
||||
| ------ | ------ |
|
||||
| api | `ApiInterface$Rx` |
|
||||
|
||||
**Returns:** `(Anonymous function)`
|
||||
|
||||
___
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
|
||||
*Defined in [democracy/referendumInfos.ts:12](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendumInfos.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/democracy/referendums.ts#L13)*
|
||||
*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendums.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
|
||||
*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/democracy/votes.ts#L12)*
|
||||
*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/democracy/votes.ts#L12)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
▸ **decorateDerive**(api: *`ApiInterface$Rx`*): [Derive](../interfaces/_index_.derive.md)
|
||||
|
||||
*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/index.ts#L35)*
|
||||
*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/index.ts#L35)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/session/eraLength.ts#L13)*
|
||||
*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/session/eraLength.ts#L13)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/session/eraProgress.ts#L14)*
|
||||
*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/session/eraProgress.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/session/sessionProgress.ts#L14)*
|
||||
*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/session/sessionProgress.ts#L14)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
|
||||
|
||||
*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/staking/intentionsBalances.ts#L18)*
|
||||
*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/staking/intentionsBalances.ts#L18)*
|
||||
|
||||
Get the balances for all intentions and their nominators
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
**Ƭ DerivedBalances**: *`object`*
|
||||
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/types.ts#L8)*
|
||||
*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/types.ts#L8)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -19,7 +19,7 @@ ___
|
||||
|
||||
**Ƭ DerivedBalancesMap**: *`object`*
|
||||
|
||||
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/types.ts#L26)*
|
||||
*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/types.ts#L26)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -32,7 +32,7 @@ ___
|
||||
|
||||
**Ƭ DerivedFees**: *`object`*
|
||||
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/types.ts#L18)*
|
||||
*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/types.ts#L18)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
@@ -43,7 +43,7 @@ ___
|
||||
|
||||
**Ƭ DerivedReferendumVote**: *`object`*
|
||||
|
||||
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/types.ts#L30)*
|
||||
*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/types.ts#L30)*
|
||||
|
||||
#### Type declaration
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
|
||||
|
||||
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/b960580/packages/api-derive/src/util/cache.ts#L23)*
|
||||
*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/b40d7a3/packages/api-derive/src/util/cache.ts#L23)*
|
||||
|
||||
Create memoization for a 2-currified function.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user