name: KeyValueOption

description: A key/value change. This is similar to the KeyValue structure, however in this case the value could be optional. Here it extends from a Tuple, indicating the use inside areas such as StorageChangeSet

Hierarchy

↳ Tuple

↳ KeyValueOption

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new KeyValueOption(value?: KeyValueOptionValue | Uint8Array): KeyValueOption

Overrides Tuple.constructor

Defined in KeyValue.ts:58

Parameters:

Name Type
Optional value KeyValueOptionValue Uint8Array

Returns: KeyValueOption

Accessors

Types

getTypes(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

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

Returns: number

key

getkey(): StorageKey

Defined in KeyValue.ts:69

description: The StorageKey

Returns: StorageKey

value

getvalue(): Option<StorageData>

Defined in KeyValue.ts:76

description: The Option StorageData

Returns: Option<StorageData>

Methods

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:91

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

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string

toU8a

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

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:109

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(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

results matching ""

    No results matching ""