Class: CreatorCreditsDoc<T>

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

Extends#

• BaseNumberTypeClass<CreatorCreditsDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iCreatorCreditsDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iCreatorCreditsDoc<T>

Returns#

CreatorCreditsDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iCreatorCreditsDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iCreatorCreditsDoc._id

---

apiTokensUsed?#

optional apiTokensUsed?: T

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

Unified APITOKEN spend counter — charged by both the AI Builder and the main API-metering middleware against the same on-chain APITOKEN balance. 1 USDC = 100,000 APITOKEN.

Implementation of#

iCreatorCreditsDoc.apiTokensUsed

---

credits#

credits: T

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

The total credits

Implementation of#

iCreatorCreditsDoc.credits

---

creditsLimit?#

optional creditsLimit?: T

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

The limit of credits

Implementation of#

iCreatorCreditsDoc.creditsLimit

Methods#

clone()#

clone(): CreatorCreditsDoc

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

Deep copies the object and returns a new instance.

Returns#

CreatorCreditsDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CreatorCreditsDoc<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:1703

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