Class: GetSearchPayload<T>

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

Extends#

• BaseNumberTypeClass<GetSearchPayload<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iGetSearchPayload<T>

Constructors#

Constructor#

new GetSearchPayload<T>(payload): GetSearchPayload<T>

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

Parameters#

payload#

iGetSearchPayload<T>

Returns#

GetSearchPayload<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

noAccounts?#

optional noAccounts?: boolean

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

If true, we will skip all account queries.

Implementation of#

iGetSearchPayload.noAccounts

---

noApplications?#

optional noApplications?: boolean

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

If true, we will skip all application queries.

Implementation of#

iGetSearchPayload.noApplications

---

noClaims?#

optional noClaims?: boolean

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

If true, we will skip all claim queries.

Implementation of#

iGetSearchPayload.noClaims

---

noCollections?#

optional noCollections?: boolean

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

If true, we will skip all collection queries.

Implementation of#

iGetSearchPayload.noCollections

---

noMaps?#

optional noMaps?: boolean

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

If true, we will skip all map queries.

Implementation of#

iGetSearchPayload.noMaps

---

noTokens?#

optional noTokens?: boolean

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

If true, we will skip all badge queries.

Implementation of#

iGetSearchPayload.noTokens

---

specificCollectionId?#

optional specificCollectionId?: string

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

If true, we will limit collection-based results to a single collection.

Implementation of#

iGetSearchPayload.specificCollectionId

Methods#

clone()#

clone(): GetSearchPayload

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

Deep copies the object and returns a new instance.

Returns#

GetSearchPayload

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

GetSearchPayload<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/requests.ts:294

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

---

FromQuery()#

static FromQuery(query): GetSearchPayload<NumberType>

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

Parameters#

query#

ParsedQs

Returns#

GetSearchPayload<NumberType>