Class Struct<S, V, E>`No Inherit Doc`

Name

Struct

Description

A Struct defines an Object with key-value pairs - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order.

Type Parameters

S extends TypesDef = TypesDef
V extends { [K in keyof S]: any } = { [K in keyof S]: any }
E extends { [K in keyof S]: string } = { [K in keyof S]: string }

Hierarchy (View Summary)

Map<keyof S, Codec>
- Struct
  - Linkage

Implements

IStruct<keyof S>

Index

Constructors

constructor

new Struct<
    S extends TypesDef<Codec> = TypesDef<Codec>,
    V extends
        { [K in string | number | symbol]: any } = {
        [K in string | number | symbol]: any
    },
    E extends
        { [K in string
        | number
        | symbol]: string } = { [K in string | number | symbol]: string },
>(
    registry: Registry,
    Types: S,
    value?: `0x${string}` | unknown[] | V | Map<unknown, unknown> | null,
    jsonMap?: Map<string, string>,
    __namedParameters?: DefinitionSetter<Definition>,
): Struct<S, V, E>
Type Parameters
- S extends TypesDef<Codec> = TypesDef<Codec>
- V extends { [K in string | number | symbol]: any } = { [K in string | number | symbol]: any }
- E extends { [K in string | number | symbol]: string } = { [K in string | number | symbol]: string }
Parameters
- registry: Registry
- Types: S
- Optionalvalue: `0x${string}` | unknown[] | V | Map<unknown, unknown> | null
- jsonMap: Map<string, string> = ...
- __namedParameters: DefinitionSetter<Definition> = {}
Returns Struct<S, V, E>
Overrides Map<keyof S, Codec>.constructor
- Defined in packages/types-codec/src/native/Struct.ts:113

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

defKeys

get defKeys(): string[]
Returns string[]

Description
The available keys for this struct
Implementation of IStruct.defKeys
- Defined in packages/types-codec/src/native/Struct.ts:154

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Implementation of IStruct.encodedLength
- Defined in packages/types-codec/src/native/Struct.ts:168

hash

get hash(): IU8a
Returns IU8a

Description
returns a hash of the contents
Implementation of IStruct.hash
- Defined in packages/types-codec/src/native/Struct.ts:181

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the value is an empty value '{}'
Implementation of IStruct.isEmpty
- Defined in packages/types-codec/src/native/Struct.ts:161

Type

get Type(): E
Returns E

Description
Returns the Type description of the structure
- Defined in packages/types-codec/src/native/Struct.ts:188

Methods

[iterator]

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

Returns IterableIterator<[keyof S, Codec]>
Implementation of IStruct.[iterator]

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

clear

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

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

delete

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

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

entries

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

Returns IterableIterator<[keyof S, Codec]>
Implementation of IStruct.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 IStruct.eq
- Defined in packages/types-codec/src/native/Struct.ts:202

forEach

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

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

get

get(key: keyof S): Codec | undefined
Parameters
- key: keyof S
  The name of the entry to retrieve
Returns Codec | undefined

Description
Returns a specific names entry in the structure
Implementation of IStruct.get

Overrides Map.get
- Defined in packages/types-codec/src/native/Struct.ts:210

getAtIndex

getAtIndex(index: number): Codec
Parameters
- index: number
Returns Codec

Description
Returns the values of a member at a specific index (Rather use get(name) for performance)
Implementation of IStruct.getAtIndex
- Defined in packages/types-codec/src/native/Struct.ts:217

getT

getT<T = Codec>(key: string): T
Type Parameters
- T = Codec
Parameters
- key: string
Returns T

Description
Returns the a types value by name
- Defined in packages/types-codec/src/native/Struct.ts:224

has

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

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

inspect

inspect(isBare?: BareOpts): Inspect
Parameters
- OptionalisBare: BareOpts
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Implementation of IStruct.inspect
- Defined in packages/types-codec/src/native/Struct.ts:231

keys

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

Returns IterableIterator<keyof S>
Implementation of IStruct.keys

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

set

set(key: keyof S, value: Codec): 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: keyof S
- value: Codec
Returns this
Implementation of IStruct.set

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

toArray

toArray(): Codec[]
Returns Codec[]

Description
Converts the Object to an standard JavaScript Array
Implementation of IStruct.toArray
- Defined in packages/types-codec/src/native/Struct.ts:253

toHex

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

Description
Returns a hex string representation of the value
Implementation of IStruct.toHex
- Defined in packages/types-codec/src/native/Struct.ts:260

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 IStruct.toHuman
- Defined in packages/types-codec/src/native/Struct.ts:267

toJSON

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

Description
Converts the Object to JSON, typically used for RPC transfers
Implementation of IStruct.toJSON
- Defined in packages/types-codec/src/native/Struct.ts:280

toPrimitive

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

Description
Converts the value in a best-fit primitive form
Implementation of IStruct.toPrimitive
- Defined in packages/types-codec/src/native/Struct.ts:295

toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Implementation of IStruct.toRawType
- Defined in packages/types-codec/src/native/Struct.ts:308

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of IStruct.toString
- Defined in packages/types-codec/src/native/Struct.ts:315

toU8a

toU8a(isBare?: BareOpts): Uint8Array
Parameters
- OptionalisBare: BareOpts
  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 IStruct.toU8a
- Defined in packages/types-codec/src/native/Struct.ts:323

values

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

Returns IterableIterator<Codec>
Implementation of IStruct.values

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

`Static`with

with<S extends TypesDef<Codec>>(
    Types: S,
    jsonMap?: Map<string, string>,
): CodecClass<
    Struct<
        S,
        { [K in string
        | number
        | symbol]: any },
        { [K in string | number | symbol]: string },
    >,
>
Type Parameters
- S extends TypesDef<Codec>
Parameters
- Types: S
- OptionaljsonMap: Map<string, string>
Returns CodecClass<
    Struct<
        S,
        { [K in string
        | number
        | symbol]: any },
        { [K in string | number | symbol]: string },
    >,
>
- Defined in packages/types-codec/src/native/Struct.ts:129

Class Struct<S, V, E>No Inherit Doc

Name

Description

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Struct<S, V, E>

Properties

Readonly[toStringTag]

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Readonlysize

Returns

Static Readonly[species]

Accessors

defKeys

Returns string[]

Description

encodedLength

Returns number

Description

hash

Returns IU8a

Description

isEmpty

Returns boolean

Description

Type

Returns E

Description

Methods

[iterator]

Returns IterableIterator<[keyof S, Codec]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[keyof S, Codec]>

eq

Parameters

Returns boolean

Description

forEach

Parameters

Returns void

get

Parameters

Returns Codec | undefined

Description

getAtIndex

Parameters

Returns Codec

Description

getT

Type Parameters

Parameters

Returns T

Description

has

Parameters

Returns boolean

inspect

Parameters

Class Struct<S, V, E>`No Inherit Doc`

`Readonly`[toStringTag]

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Readonly`size

`Static` `Readonly`[species]

`Static`with

Returns CodecClass<
Struct<
S,
{ [K in string
| number
| symbol]: any },
{ [K in string | number | symbol]: string },
>,
>