Class CodecMap<K, V>

Type Parameters

K extends Codec = Codec
V extends Codec = Codec

Hierarchy (View Summary)

Map<K, V>
- CodecMap
  - BTreeMap
  - HashMap

Implements

IMap<K, V>

Index

Constructors

constructor

new CodecMap<K extends Codec = Codec, V extends Codec = Codec>(
    registry: Registry,
    keyType: string | CodecClass<K, any[]>,
    valType: string | CodecClass<V, any[]>,
    rawValue: string | Uint8Array | Map<any, any> | undefined,
    type?: "BTreeMap" | "HashMap",
): CodecMap<K, V>
Type Parameters
- K extends Codec = Codec
- V extends Codec = Codec
Parameters
- registry: Registry
- keyType: string | CodecClass<K, any[]>
- valType: string | CodecClass<V, any[]>
- rawValue: string | Uint8Array | Map<any, any> | undefined
- type: "BTreeMap" | "HashMap" = 'HashMap'
Returns CodecMap<K, V>
Overrides Map<K, V>.constructor
- Defined in packages/types-codec/src/extended/Map.ts:107

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Optional`createdAtHash

createdAtHash?: IU8a

Description

The block at which this value was retrieved/created (set to non-empty when retrieved from storage)

`Optional`initialU8aLength

initialU8aLength?: number

Description

The length of the initial encoded value (Only available when the value was constructed from a Uint8Array input)

`Optional`isStorageFallback

isStorageFallback?: boolean

Description

(internal usage) Indicates that the value was created via a fallback. This is used when with data specified in the metadata when the storage entry is empty.

With metadata fallback values (available as defaults on most storage entries) any empty storage item should erturn the default. (This is the same as the implementation on the Bizinikiwi runtime)

`Readonly`registry

registry: Registry

Description

The registry associated with this object

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Implementation of IMap.encodedLength
- Defined in packages/types-codec/src/extended/Map.ts:122

hash

get hash(): IU8a
Returns IU8a

Description
Returns a hash of the value
Implementation of IMap.hash
- Defined in packages/types-codec/src/extended/Map.ts:135

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the value is an empty value
Implementation of IMap.isEmpty
- Defined in packages/types-codec/src/extended/Map.ts:142

Methods

[iterator]

"[iterator]"(): IterableIterator<[K, V]>
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>
Implementation of IMap.[iterator]

Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Implementation of IMap.clear

Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Implementation of IMap.delete

Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): IterableIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>
Implementation of IMap.entries

Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

eq

eq(other?: unknown): boolean
Parameters
- Optionalother: unknown
Returns boolean

Description
Compares the value of the input to see if there is a match
Implementation of IMap.eq
- Defined in packages/types-codec/src/extended/Map.ts:149

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
- OptionalthisArg: any
Returns void
Implementation of IMap.forEach

Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: K): V | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns V | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Implementation of IMap.get

Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of IMap.has

Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

inspect

inspect(): Inspect
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Implementation of IMap.inspect
- Defined in packages/types-codec/src/extended/Map.ts:156

keys

keys(): IterableIterator<K>
Returns an iterable of keys in the map

Returns IterableIterator<K>
Implementation of IMap.keys

Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(key: K, value: V): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: K
- value: V
Returns this
Implementation of IMap.set

Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

toHex

toHex(): `0x${string}`
Returns `0x${string}`

Description
Returns a hex string representation of the value. isLe returns a LE (number-only) representation
Implementation of IMap.toHex
- Defined in packages/types-codec/src/extended/Map.ts:173

toHuman

toHuman(isExtended?: boolean, disableAscii?: boolean): Record<string, AnyJson>
Parameters
- OptionalisExtended: boolean
- OptionaldisableAscii: boolean
Returns Record<string, AnyJson>

Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Implementation of IMap.toHuman
- Defined in packages/types-codec/src/extended/Map.ts:180

toJSON

toJSON(): Record<string, AnyJson>
Returns Record<string, AnyJson>

Description
Converts the Object to JSON, typically used for RPC transfers
Implementation of IMap.toJSON
- Defined in packages/types-codec/src/extended/Map.ts:197

toPrimitive

toPrimitive(disableAscii?: boolean): AnyJson
Parameters
- OptionaldisableAscii: boolean
Returns AnyJson

Description
Converts the value in a best-fit primitive form
Implementation of IMap.toPrimitive
- Defined in packages/types-codec/src/extended/Map.ts:210

toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Implementation of IMap.toRawType
- Defined in packages/types-codec/src/extended/Map.ts:227

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of IMap.toString
- Defined in packages/types-codec/src/extended/Map.ts:234

toU8a

toU8a(isBare?: boolean): Uint8Array
Parameters
- OptionalisBare: boolean
  true when the value has none of the type-specific prefixes (internal)
Returns Uint8Array

Description
Encodes the value as a Uint8Array as per the SCALE specifications
Implementation of IMap.toU8a
- Defined in packages/types-codec/src/extended/Map.ts:242

values

values(): IterableIterator<V>
Returns an iterable of values in the map

Returns IterableIterator<V>
Implementation of IMap.values

Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class CodecMap<K, V>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CodecMap<K, V>

Properties

Readonly[toStringTag]

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Readonlysize

Returns

Static Readonly[species]

Accessors

encodedLength

Returns number

Description

hash

Returns IU8a

Description

isEmpty

Returns boolean

Description

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[K, V]>

eq

Parameters

Returns boolean

Description

forEach

Parameters

Returns void

get

Parameters

Returns V | undefined

has

Parameters

Returns boolean

inspect

Returns Inspect

Description

keys

Returns IterableIterator<K>

set

Parameters

Returns this

toHex

Returns `0x${string}`

Description

toHuman

Parameters

Returns Record<string, AnyJson>

Description

toJSON

Returns Record<string, AnyJson>

Description

toPrimitive

Parameters

`Readonly`[toStringTag]

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Readonly`size

`Static` `Readonly`[species]