Class: GetSearchSuccessResponse<T>

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

Inherit Doc#

iGetSearchSuccessResponse

Extends#

• BaseNumberTypeClass<GetSearchSuccessResponse<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iGetSearchSuccessResponse<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iGetSearchSuccessResponse<T>

Returns#

GetSearchSuccessResponse<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

accounts#

accounts: BitBadgesUserInfo<T>[]

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

Implementation of#

iGetSearchSuccessResponse.accounts

---

claims?#

optional claims?: ClaimDetails<T>[]

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

Implementation of#

iGetSearchSuccessResponse.claims

---

collections#

collections: BitBadgesCollection<T>[]

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

Implementation of#

iGetSearchSuccessResponse.collections

---

tokens#

tokens: object[]

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

collection#

collection: BitBadgesCollection<T>

tokenIds#

tokenIds: UintRangeArray<T>

Implementation of#

iGetSearchSuccessResponse.tokens

---

utilityPages?#

optional utilityPages?: UtilityPageDoc<T>[]

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

Implementation of#

iGetSearchSuccessResponse.utilityPages

Methods#

clone()#

clone(): GetSearchSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetSearchSuccessResponse

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

GetSearchSuccessResponse<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