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

[CI Skip] 0.32.17

Browse Source
This commit is contained in:
Travis CI
2018-12-03 10:28:14 +00:00
parent 6cab9be9c8
commit f1df2f7c75
219 changed files with 12988 additions and 2017 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-observable/classes/_classes_.rxproposal.md
+30 -16
View File
@@ -25,7 +25,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L12)*
*Defined in [classes.ts:12](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L12)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L125)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L129)*
**Returns:** `E`
@@ -83,7 +83,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L21)*
*Defined in [classes.ts:21](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L21)*
**Returns:** `AccountId`
@@ -96,7 +96,9 @@ getencodedLength(): `number`
*Inherited from Struct.encodedLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:129](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L129)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:136](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L136)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
@@ -107,7 +109,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L25)*
*Defined in [classes.ts:25](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L25)*
**Returns:** `PropIndex`
@@ -118,7 +120,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/82dcbe5/packages/api-observable/src/classes.ts#L29)*
*Defined in [classes.ts:29](https://github.com/polkadot-js/api/blob/6cab9be/packages/api-observable/src/classes.ts#L29)*
**Returns:** `Proposal`
@@ -235,7 +237,9 @@ ___
*Inherited from Struct.getAtIndex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:135](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L135)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L145)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
**Parameters:**
@@ -308,7 +312,9 @@ ___
*Inherited from Struct.toArray*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:139](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L139)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:152](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L152)*
*__description__*: Converts the Object to an standard JavaScript Array
**Returns:** `Array`<`Codec`>
@@ -321,7 +327,9 @@ ___
*Inherited from Struct.toHex*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:143](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L143)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a hex string representation of the value
**Returns:** `string`
@@ -334,7 +342,9 @@ ___
*Inherited from Struct.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
**Returns:** `any`
@@ -347,7 +357,9 @@ ___
*Inherited from Struct.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L158)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns the string representation of the value
**Returns:** `string`
@@ -360,13 +372,15 @@ ___
*Inherited from Struct.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:162](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L162)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:188](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L188)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
| Name | Type | Description |
| ------ | ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`| true when the value has none of the type-specific prefixes (internal) |
**Returns:** `Uint8Array`
@@ -394,7 +408,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:108](https://github.com/polkadot-js/api/blob/82dcbe5/packages/types/src/codec/Struct.ts#L108)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:112](https://github.com/polkadot-js/api/blob/6cab9be/packages/types/src/codec/Struct.ts#L112)*
**Type parameters:**