Class: ApprovalTrackerDoc<T>

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

Extends#

• BaseNumberTypeClass<ApprovalTrackerDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iApprovalTrackerDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iApprovalTrackerDoc<T> & Doc & iAmountTrackerIdDetails<T>

Returns#

ApprovalTrackerDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iApprovalTrackerDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iApprovalTrackerDoc._id

---

amounts#

amounts: BalanceArray<T>

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

A tally of the amounts transferred for this approval.

Implementation of#

iApprovalTrackerDoc.amounts

---

amountTrackerId#

amountTrackerId: string

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

The amount tracker ID of the approval.

Implementation of#

iApprovalTrackerDoc.amountTrackerId

---

approvalId#

approvalId: string

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

The approval ID

Implementation of#

iApprovalTrackerDoc.approvalId

---

approvalLevel#

approvalLevel: string

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

The approval level of the approval "collection", "incoming", or "outgoing".

Implementation of#

iApprovalTrackerDoc.approvalLevel

---

approvedAddress#

approvedAddress: string

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

The address to check for the approval.

Implementation of#

iApprovalTrackerDoc.approvedAddress

---

approverAddress#

approverAddress: string

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

The address of the approval to check.

Implementation of#

iApprovalTrackerDoc.approverAddress

---

collectionId#

collectionId: string

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

The collection ID for the approval.

Implementation of#

iApprovalTrackerDoc.collectionId

---

lastUpdatedAt#

lastUpdatedAt: T

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

Last updated timestamp

Implementation of#

iApprovalTrackerDoc.lastUpdatedAt

---

numTransfers#

numTransfers: T

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

The number of transfers. Is an incrementing tally.

Implementation of#

iApprovalTrackerDoc.numTransfers

---

trackerType#

trackerType: string

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

The type of tracker to check "overall", "to", "from", or "initiatedBy".

Implementation of#

iApprovalTrackerDoc.trackerType

Methods#

clone()#

clone(): ApprovalTrackerDoc

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

Deep copies the object and returns a new instance.

Returns#

ApprovalTrackerDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ApprovalTrackerDoc<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:1511

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