Class: GetCollectionOwnersSuccessResponse<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:67

Extends#

• BaseNumberTypeClass<GetCollectionOwnersSuccessResponse<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iGetCollectionOwnersSuccessResponse<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:75

Parameters#

data#

iGetCollectionOwnersSuccessResponse<T>

Returns#

GetCollectionOwnersSuccessResponse<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

counts?#

optional counts?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:73

Present only when tokenId was provided. Holder counts for that tier. Plain integers (holder counts, well within safe-integer range) — not NumberType, so they aren't affected by number-type conversion.

active#

active: number

expired#

expired: number

total#

total: number

Implementation of#

iGetCollectionOwnersSuccessResponse.counts

---

owners#

owners: BalanceDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:71

Implementation of#

iGetCollectionOwnersSuccessResponse.owners

---

pagination#

pagination: PaginationInfo

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:72

Implementation of#

iGetCollectionOwnersSuccessResponse.pagination

Methods#

clone()#

clone(): GetCollectionOwnersSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetCollectionOwnersSuccessResponse

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/wrappers.ts:86

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

GetCollectionOwnersSuccessResponse<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/requests/wrappers.ts:82

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