Class: BalanceDoc<T>

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

Extends#

• BaseNumberTypeClass<BalanceDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iBalanceDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iBalanceDoc<T> & Doc & iUserBalanceStore<T>

Returns#

BalanceDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iBalanceDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iBalanceDoc._id

---

autoApproveAllIncomingTransfers#

autoApproveAllIncomingTransfers: boolean

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

Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Implementation of#

iBalanceDoc.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers#

autoApproveSelfInitiatedIncomingTransfers: boolean

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

Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Implementation of#

iBalanceDoc.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers#

autoApproveSelfInitiatedOutgoingTransfers: boolean

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

Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.

Implementation of#

iBalanceDoc.autoApproveSelfInitiatedOutgoingTransfers

---

balances#

balances: BalanceArray<T>

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

The user's balances.

Implementation of#

iBalanceDoc.balances

---

bitbadgesAddress#

bitbadgesAddress: string

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

The BitBadges address of the user

Implementation of#

iBalanceDoc.bitbadgesAddress

---

collectionId#

collectionId: string

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

The collection ID

Implementation of#

iBalanceDoc.collectionId

---

incomingApprovals#

incomingApprovals: UserIncomingApproval<T>[]

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

The user's incoming approvals.

Implementation of#

iBalanceDoc.incomingApprovals

---

outgoingApprovals#

outgoingApprovals: UserOutgoingApproval<T>[]

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

The user's outgoing approvals.

Implementation of#

iBalanceDoc.outgoingApprovals

---

tags?#

optional tags?: string[]

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

Optional tags for this balance

Implementation of#

iBalanceDoc.tags

---

updateHistory#

updateHistory: UpdateHistory<T>[]

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

The update history of this balance

Implementation of#

iBalanceDoc.updateHistory

---

userPermissions#

userPermissions: UserPermissions<T>

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

The user's permissions.

Implementation of#

iBalanceDoc.userPermissions

Methods#

clone()#

clone(): BalanceDoc

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

Deep copies the object and returns a new instance.

Returns#

BalanceDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

BalanceDoc<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:994

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