Class: GetBalanceByAddressPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/collections.ts:240

Extends#

• CustomTypeClass<GetBalanceByAddressPayload>

Implements#

• iGetBalanceByAddressPayload

Constructors#

Constructor#

new GetBalanceByAddressPayload(payload): GetBalanceByAddressPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/collections.ts:244

Parameters#

payload#

iGetBalanceByAddressPayload

Returns#

GetBalanceByAddressPayload

Overrides#

CustomTypeClass.constructor

Properties#

fetchPrivateParams?#

optional fetchPrivateParams?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/collections.ts:241

If true, we will fetch private parameters for any claims / approvals. Must be creator.

This is only applicable to incoming / outgoing approvals with claims.

Implementation of#

iGetBalanceByAddressPayload.fetchPrivateParams

---

forceful?#

optional forceful?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/collections.ts:242

If true, we will forcefully fetch the balance even if it is already cached. Only applicable to non-indexed / on-demand collections.

Implementation of#

iGetBalanceByAddressPayload.forceful

Methods#

clone()#

clone(): GetBalanceByAddressPayload

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

Deep copies the object and returns a new instance.

Returns#

GetBalanceByAddressPayload

Inherited from#

CustomTypeClass.clone

---

convert()#

convert<U>(_convertFunction?, options?): CustomType<any>

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

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from#

CustomTypeClass.convert

---

equals()#

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

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

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

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString

---

FromQuery()#

static FromQuery(query): GetBalanceByAddressPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/collections.ts:250

Parameters#

query#

ParsedQs

Returns#

GetBalanceByAddressPayload