Class MapDoc<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

MapWithValues<T>
- MapDoc

Implements

iMapDoc<T>

Constructors

constructor

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

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

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 MapWithValues.clone
- Defined in src/common/base.ts:121

convert

convert<U>(convertFunction, options?): MapDoc<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
- Optionaloptions: ConvertOptions
Returns MapDoc<U>
Overrides MapWithValues.convert
- Defined in src/api-indexer/docs/docs.ts:1844

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 MapWithValues.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

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

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

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from MapWithValues.hasNumberFields
- Defined in src/common/base.ts:131

toJson

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

Returns JsonObject
Inherited from MapWithValues.toJson
- Defined in src/common/base.ts:109

toJsonString

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

Returns string
Inherited from MapWithValues.toJsonString
- Defined in src/common/base.ts:113