Class: GetOwnersSuccessResponse<T>

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

Extends#

• BaseNumberTypeClass<GetOwnersSuccessResponse<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iGetOwnersSuccessResponse<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iGetOwnersSuccessResponse<T>

Returns#

GetOwnersSuccessResponse<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

owners#

owners: BalanceDocWithDetails<T>[]

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

Represents a list of owners balance details.

Implementation of#

iGetOwnersSuccessResponse.owners

---

pagination#

pagination: PaginationInfo

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

Represents pagination information.

Implementation of#

iGetOwnersSuccessResponse.pagination

Methods#

clone()#

clone(): GetOwnersSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetOwnersSuccessResponse

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

GetOwnersSuccessResponse<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/common/base.ts:157

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

Returns#

string[]

Inherited from#

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