name: ChainProperties
description: Wraps the properties retrieved from the chain via the system.properties RPC call. It extends the standard JS Map with known values exposed as a getter. While it implements a Codec, it is limited ain that it can only be used with input objects, i.e. no hex decoding.
Hierarchy
Map<string, any>
↳ ChainProperties
Implements
Constructors
constructor
⊕ new ChainProperties(value?: object): ChainProperties
Defined in ChainProperties.ts:17
Parameters:
| Name | Type | Default value |
|---|---|---|
Default value value |
object |
{} |
Returns: ChainProperties
Properties
<Static> Map
● Map: MapConstructor
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36
Accessors
encodedLength
getencodedLength(): number
Defined in ChainProperties.ts:31
description: Always 0, never encodes as a Uint8Array
Returns: number
Methods
get
▸ get(name: string): any | undefined
Overrides Map.get
Defined in ChainProperties.ts:39
description: Returns a specific names entry in the structure
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string |
The name of the entry to retrieve |
Returns: any | undefined
toHex
▸ toHex(): string
Defined in ChainProperties.ts:46
description: Unimplemented, will throw
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in ChainProperties.ts:53
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Implementation of Codec.toString
Defined in ChainProperties.ts:64
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in ChainProperties.ts:71
description: Unimplemented, will throw
Parameters:
| Name | Type |
|---|---|
Optional isBare |
undefined | false | true |
Returns: Uint8Array