Class: GetCollectionSuccessResponse<T>

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

Extends#

• BaseNumberTypeClass<GetCollectionSuccessResponse<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iGetCollectionSuccessResponse<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iGetCollectionSuccessResponse<T>

Returns#

GetCollectionSuccessResponse<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

collection#

collection: BitBadgesCollection<T>

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

The collection details

Implementation of#

iGetCollectionSuccessResponse.collection

---

metadata#

metadata: Metadata<T>

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

The current collection metadata

Implementation of#

iGetCollectionSuccessResponse.metadata

Methods#

clone()#

clone(): GetCollectionSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetCollectionSuccessResponse

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

GetCollectionSuccessResponse<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:519

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