Class MapWithValues<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

Map<T>
- MapWithValues
  - MapDoc

Implements

iMapWithValues<T>

Index

Constructors

Properties

creator defaultValue inheritManagerTimelineFrom managerTimeline mapId metadata? metadataTimeline permissions updateCriteria updateHistory valueOptions values

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new MapWithValues<T>(data): MapWithValues<T>
Type Parameters
- T extends NumberType
Parameters
- data: iMapWithValues<T>
Returns MapWithValues<T>
Overrides Map.constructor
- Defined in src/api-indexer/docs/docs.ts:1657

Properties

creator

creator: string

defaultValue

defaultValue: string

inheritManagerTimelineFrom

inheritManagerTimelineFrom: T

managerTimeline

managerTimeline: ManagerTimeline<T>[]

mapId

mapId: string

`Optional`metadata

metadata?: Metadata<T>

The fetched metadata for the map (if any).

metadataTimeline

metadataTimeline: MapMetadataTimeline<T>[]

permissions

permissions: MapPermissions<T>

updateCriteria

updateCriteria: MapUpdateCriteria<T>

updateHistory

updateHistory: UpdateHistory<T>[]

The update history for the map. Maps are maintained through blockchain transactions.

valueOptions

valueOptions: ValueOptions

values

values: {
[key: string]: ValueStore;
}

The (key, value) pairs for the maps that are set.

Methods

clone

clone(): Map<T>
Deep copies the object and returns a new instance.

Returns Map<T>
Inherited from Map.clone
- Defined in src/common/base.ts:100

convert

convert<U>(convertFunction): MapWithValues<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((val: NumberType) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
Returns MapWithValues<U>
Overrides Map.convert
- Defined in src/api-indexer/docs/docs.ts:1668

equals

equals<U>(other, normalizeNumberTypes?): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from Map.equals
- Defined in src/common/base.ts:96

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides Map.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:1664

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from Map.toJson
- Defined in src/common/base.ts:88

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from Map.toJsonString
- Defined in src/common/base.ts:92