Class: UserBalanceStoreWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:77

Extends#

• UserBalanceStore<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iUserBalanceStoreWithDetails<T>
• CustomType<UserBalanceStoreWithDetails<T>>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:85

Parameters#

data#

iUserBalanceStoreWithDetails<T>

Returns#

UserBalanceStoreWithDetails<T>

Overrides#

UserBalanceStore.constructor

Properties#

autoApproveAllIncomingTransfers#

autoApproveAllIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:23

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

Implementation of#

iUserBalanceStoreWithDetails.autoApproveAllIncomingTransfers

Inherited from#

UserBalanceStore.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers#

autoApproveSelfInitiatedIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:22

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

Implementation of#

iUserBalanceStoreWithDetails.autoApproveSelfInitiatedIncomingTransfers

Inherited from#

UserBalanceStore.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers#

autoApproveSelfInitiatedOutgoingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:21

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

Implementation of#

iUserBalanceStoreWithDetails.autoApproveSelfInitiatedOutgoingTransfers

Inherited from#

UserBalanceStore.autoApproveSelfInitiatedOutgoingTransfers

---

balances#

balances: BalanceArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:17

The user's balances.

Implementation of#

iUserBalanceStoreWithDetails.balances

Inherited from#

UserBalanceStore.balances

---

incomingApprovals#

incomingApprovals: UserIncomingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:82

The user's incoming approvals.

Implementation of#

iUserBalanceStoreWithDetails.incomingApprovals

Overrides#

UserBalanceStore.incomingApprovals

---

outgoingApprovals#

outgoingApprovals: UserOutgoingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:81

The user's outgoing approvals.

Implementation of#

iUserBalanceStoreWithDetails.outgoingApprovals

Overrides#

UserBalanceStore.outgoingApprovals

---

userPermissions#

userPermissions: UserPermissionsWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:83

The user's permissions.

Implementation of#

iUserBalanceStoreWithDetails.userPermissions

Overrides#

UserBalanceStore.userPermissions

Methods#

clone()#

clone(): UserBalanceStoreWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:96

Deep copies the object and returns a new instance.

Returns#

UserBalanceStoreWithDetails<T>

Implementation of#

CustomType.clone

Overrides#

UserBalanceStore.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:92

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserBalanceStoreWithDetails<U>

Implementation of#

CustomType.convert

Overrides#

UserBalanceStore.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

Implementation of#

CustomType.equals

Inherited from#

UserBalanceStore.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Implementation of#

CustomType.getNumberFieldNames

Inherited from#

UserBalanceStore.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Implementation of#

CustomType.hasNumberFields

Inherited from#

UserBalanceStore.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:64

Parameters#

prefix#

string

Returns#

UserBalanceStore<T>

Inherited from#

UserBalanceStore.toBech32Addresses

---

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

Implementation of#

CustomType.toJson

Inherited from#

UserBalanceStore.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Implementation of#

CustomType.toJsonString

Inherited from#

UserBalanceStore.toJsonString

---

toProto()#

toProto(): UserBalanceStore

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:40

Returns#

UserBalanceStore

Inherited from#

UserBalanceStore.toProto

---

fromProto()#

static fromProto<T>(item, convertFunction): UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:44

Type Parameters#

T#

T extends NumberType

Parameters#

item#

UserBalanceStore

convertFunction#

(item) => T

Returns#

UserBalanceStore<T>

Inherited from#

UserBalanceStore.fromProto