Pezkuwi API
    Preparing search index...

    Class BTreeMap<K, V>

    Type Parameters

    • K extends Codec = Codec
    • V extends Codec = Codec

    Hierarchy (View Summary)

    Index
    constructor
    [toStringTag] createdAtHash? initialU8aLength? isStorageFallback? registry size [species]
    encodedLength hash isEmpty
    [iterator] clear delete entries eq forEach get has inspect keys set toHex toHuman toJSON toPrimitive toRawType toString toU8a values with

    • 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 BTreeMap<K, V>

    "[toStringTag]": string
    createdAtHash?: IU8a

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

    initialU8aLength?: number

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

    isStorageFallback?: boolean

    (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)

    registry: Registry

    The registry associated with this object

    size: number

    the number of elements in the Map.

    "[species]": MapConstructor

    • Returns an iterable of entries in the map.

      Returns IterableIterator<[K, V]>

    • Returns void

    • 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.

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

      Returns IterableIterator<[K, V]>

    • 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

    • 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.

    • Parameters

      • key: K

      Returns boolean

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

    • Returns an iterable of keys in the map

      Returns IterableIterator<K>

    • 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

    • Parameters

      • OptionalisExtended: boolean
      • OptionaldisableAscii: boolean

      Returns Record<string, AnyJson>

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

    • Parameters

      • OptionalisBare: boolean

        true when the value has none of the type-specific prefixes (internal)

      Returns Uint8Array

      Encodes the value as a Uint8Array as per the SCALE specifications

    • Returns an iterable of values in the map

      Returns IterableIterator<V>

    • Type Parameters

      • K extends Codec
      • V extends Codec

      Parameters

      • keyType: string | CodecClass<K, any[]>
      • valType: string | CodecClass<V, any[]>

      Returns CodecClass<CodecMap<K, V>>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods