Interface Tally

Readonly [toStringTag]

Optional createdAtHash

Optional initialU8aLength

Optional isStorageFallback

Readonly registry

Readonly size

Type

• get Type(): E

• Returns E

  Description

  Returns the Type description of the structure

defKeys

• get defKeys(): string[]

• Returns string[]

  Description

  The available keys for this struct

encodedLength

• get encodedLength(): number

• Returns number

  Description

  The length of the value when encoded as a Uint8Array

hash

• get hash(): IU8a

• Returns IU8a

  Description

  returns a hash of the contents

isEmpty

• get isEmpty(): boolean

• Returns boolean

  Description

  Checks if the value is an empty value

[iterator]

• [iterator](): IterableIterator<[string, Codec]>

• Returns an iterable of entries in the map.

  Returns IterableIterator<[string, Codec]>

clear

• clear(): void

• Returns void

delete

• delete(key): boolean

• Parameters

  • key: string

  Returns boolean

  true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

• entries(): IterableIterator<[string, Codec]>

• Returns an iterable of key, value pairs for every entry in the map.

  Returns IterableIterator<[string, Codec]>

eq

• eq(other?): boolean

• Parameters

  • Optional other: unknown

  Returns boolean

  Description

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

forEach

• forEach(callbackfn, thisArg?): void

• Executes a provided function once per each key/value pair in the Map, in insertion order.

  Parameters

  • callbackfn: ((value, key, map) => void)
    • • (value, key, map): void

      • Parameters

        • value: Codec
        • key: string
        • map: Map<string, Codec>

        Returns void

  • Optional thisArg: any

  Returns void

get

• get(key): Codec

• Parameters

  • key: string

    The name of the entry to retrieve

  Returns Codec

  Description

  Returns a specific names entry in the structure

getAtIndex

• getAtIndex(index): Codec

• Parameters

  • index: number

  Returns Codec

  Description

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

getT

• getT<T>(key): T

• Type Parameters

  • T = Codec

  Parameters

  • key: string

  Returns T

  Description

  Returns the a types value by name

has

• has(key): boolean

• Parameters

  • key: string

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

inspect

• inspect(isBare?): Inspect

• Parameters

  • Optional isBare: BareOpts

  Returns Inspect

  Description

  Returns a breakdown of the hex encoding for this Codec

keys

• keys(): IterableIterator<string>

• Returns an iterable of keys in the map

  Returns IterableIterator<string>

set

• set(key, value): 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: string
  • value: Codec

  Returns this

toArray

• toArray(): Codec[]

• Returns Codec[]

  Description

  Converts the Object to an standard JavaScript Array

toHex

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

• Returns `0x${string}`

  Description

  Returns a hex string representation of the value

toHuman

• toHuman(isExtended?, disableAscii?): Record<string, AnyJson>

• Parameters

  • Optional isExtended: boolean
  • Optional disableAscii: boolean

  Returns Record<string, AnyJson>

  Description

  Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information

toJSON

• toJSON(): Record<string, AnyJson>

• Returns Record<string, AnyJson>

  Description

  Converts the Object to JSON, typically used for RPC transfers

toPrimitive

• toPrimitive(disableAscii?): Record<string, AnyJson>

• Parameters

  • Optional disableAscii: boolean

  Returns Record<string, AnyJson>

  Description

  Converts the value in a best-fit primitive form

toRawType

• toRawType(): string

• Returns string

  Description

  Returns the base runtime type name for this instance

toString

• toString(): string

• Returns string

  Description

  Returns the string representation of the value

toU8a

• toU8a(isBare?): Uint8Array

• Parameters

  • Optional isBare: 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

values

• values(): IterableIterator<Codec>

• Returns an iterable of values in the map

  Returns IterableIterator<Codec>