name: StorageKey

description: A representation of a storage key (typically hashed) in the system. It can be constructed by passing in a raw key or a StorageFunction with (optional) arguments.

Hierarchy

↳ Bytes

↳ StorageKey

Implements

• Codec

Indexable

[index: number]: number

Constructors

constructor

⊕ new StorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): StorageKey

Overrides Bytes.constructor

Defined in StorageKey.ts:28

Parameters:

Returns: StorageKey

Accessors

encodedLength

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in Bytes.ts:61

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

Returns: number

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

meta

getmeta(): StorageFunctionMetadata | null

Defined in StorageKey.ts:82

description: The metadata or null when not available

Returns: StorageFunctionMetadata | null

outputType

getoutputType(): string | null

Defined in StorageKey.ts:89

description: The output type, null when not available

Returns: string | null

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Returns: boolean

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

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

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

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

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Returns: Uint8Array

<Static> decodeStorageKey

▸ decodeStorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): Uint8Array

Defined in StorageKey.ts:37

Parameters:

Returns: Uint8Array

<Static> getMeta

▸ getMeta(value: StorageKey | StorageFunction | [StorageFunction, any]): StorageFunctionMetadata | null

Defined in StorageKey.ts:51

Parameters:

Returns: StorageFunctionMetadata | null

<Static> getType

▸ getType(value: StorageKey | StorageFunction | [StorageFunction, any]): string | null

Defined in StorageKey.ts:65

Parameters:

Returns: string | null