Skip to content

Class: GetBrowsePayload

iGetBrowsePayload

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

Extends

Implements

Constructors

Constructor

new GetBrowsePayload(payload): GetBrowsePayload

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

Parameters

payload

iGetBrowsePayload

Returns

GetBrowsePayload

Overrides

CustomTypeClass.constructor

Properties

category?

optional category?: string

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

Implementation of

iGetBrowsePayload.category

locale?

optional locale?: string

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

Implementation of

iGetBrowsePayload.locale

searchTerm?

optional searchTerm?: string

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

Implementation of

iGetBrowsePayload.searchTerm

sortBy?

optional sortBy?: string

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

Implementation of

iGetBrowsePayload.sortBy

timeFrame?

optional timeFrame?: string

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

Implementation of

iGetBrowsePayload.timeFrame

type

type: "tokens" | "claims" | "applications" | "pointsActivity" | "collections" | "addressLists" | "maps" | "activity" | "utilityPages" | "claimActivity"

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

Implementation of

iGetBrowsePayload.type

Methods

clone()

clone(): GetBrowsePayload

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

Deep copies the object and returns a new instance.

Returns

GetBrowsePayload

Inherited from

CustomTypeClass.clone

convert()

convert<U>(_convertFunction?, options?): CustomType<any>

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

Type Parameters

U

U extends NumberType

Parameters

_convertFunction?

(val) => U

options?

ConvertOptions

Returns

CustomType<any>

Deprecated

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from

CustomTypeClass.convert

equals()

equals<U>(other, normalizeNumberTypes?): boolean

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

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

CustomTypeClass.equals

getNumberFieldNames()

getNumberFieldNames(): string[]

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

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

Returns

string[]

Inherited from

CustomTypeClass.getNumberFieldNames

hasNumberFields()

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns

boolean

Inherited from

CustomTypeClass.hasNumberFields

toJson()

toJson(): JsonObject

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

Converts the object to a JSON object with all primitive types.

Returns

JsonObject

Inherited from

CustomTypeClass.toJson

toJsonString()

toJsonString(): string

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

Converts the object to a JSON string.

Returns

string

Inherited from

CustomTypeClass.toJsonString

FromQuery()

static FromQuery(query): GetBrowsePayload

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

Parameters

query

ParsedQs

Returns

GetBrowsePayload

Edit this page on GitHub