name: KeyValue

description: KeyValue structure. Since most of the keys and resultant values in Subtrate is hashed and/or encoded, this does not wrap Text, but rather a Bytes for the keys and values. (Not to be confused with the KeyValue in Metadata, that is actually for Maps, whereas this is a representation of actaul storage values)

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ KeyValue

Implements

Constructors

constructor

⊕ new KeyValue(value?: KeyValueValue | Uint8Array): KeyValue

Overrides Struct.constructor

Defined in KeyValue.ts:26

Parameters:

Name Type
Optional value KeyValueValue Uint8Array

Returns: KeyValue

Accessors

Type

getType(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number

key

getkey(): StorageKey

Defined in KeyValue.ts:37

description: The StorageKey

Returns: StorageKey

value

getvalue(): StorageData

Defined in KeyValue.ts:44

description: The StorageData

Returns: StorageData

Methods

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:159

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string

toU8a

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

Inherited from Struct.toU8a

Defined in codec/Struct.ts:209

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

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

results matching ""

    No results matching ""