Class: PointsDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1052

Extends#

• BaseNumberTypeClass<PointsDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iPointsDoc<T>

Constructors#

Constructor#

new PointsDoc<T>(data): PointsDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1062

Parameters#

data#

iPointsDoc<T>

Returns#

PointsDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1053

A unique stringified document ID

Implementation of#

iPointsDoc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1054

A unique document ID (Mongo DB ObjectID)

Implementation of#

iPointsDoc._id

---

address#

address: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1055

The address to calculate points for

Implementation of#

iPointsDoc.address

---

applicationId#

applicationId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1058

The application ID

Implementation of#

iPointsDoc.applicationId

---

claimSuccessCounts?#

optional claimSuccessCounts?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1060

Claim success counts. These were the claim success counts calculated for this points calculation.

Index Signature#

[claimId: string]: number

Implementation of#

iPointsDoc.claimSuccessCounts

---

lastCalculatedAt#

lastCalculatedAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1057

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

Implementation of#

iPointsDoc.lastCalculatedAt

---

pageId#

pageId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1059

The page ID

Implementation of#

iPointsDoc.pageId

---

points#

points: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1056

The points for the address

Implementation of#

iPointsDoc.points

Methods#

clone()#

clone(): PointsDoc

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

PointsDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): PointsDoc<U>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1078

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PointsDoc<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1074

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString