Class PointsDoc<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<PointsDoc<T>>
- PointsDoc

Implements

iPointsDoc<T>

Index

Constructors

Properties

_docId _id? address groupId lastCalculatedAt pageId points

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new PointsDoc<T>(data): PointsDoc<T>
Type Parameters
- T extends NumberType
Parameters
- data: iPointsDoc<T>
Returns PointsDoc<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:849

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

address

address: string

The address to calculate points for

groupId

groupId: string

The group ID

lastCalculatedAt

lastCalculatedAt: T

The timestamp of when the points were last calculated (milliseconds since epoch)

pageId

pageId: string

The page ID

points

points: T

The points for the address

Methods

clone

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

Returns PointsDoc<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert<U>(convertFunction, options?): PointsDoc<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 PointsDoc<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:864

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 BaseNumberTypeClass.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 BaseNumberTypeClass.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:860

hasNumberFields

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

Returns boolean
Inherited from BaseNumberTypeClass.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 BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

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

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