Class: GetStatusPayload

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

Extends#

• CustomTypeClass<GetStatusPayload>

Implements#

• iGetStatusPayload

Constructors#

Constructor#

new GetStatusPayload(payload): GetStatusPayload

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

Parameters#

payload#

iGetStatusPayload

Returns#

GetStatusPayload

Overrides#

CustomTypeClass.constructor

Properties#

chain?#

optional chain?: "Thorchain" | "BitBadges"

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

Chain to check? Defaults to BitBadges poller.

Implementation of#

iGetStatusPayload.chain

---

withOutOfSyncCheck?#

optional withOutOfSyncCheck?: boolean

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

If true, we will check if the indexer is out of sync with the blockchain.

Implementation of#

iGetStatusPayload.withOutOfSyncCheck

Methods#

clone()#

clone(): GetStatusPayload

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

Deep copies the object and returns a new instance.

Returns#

GetStatusPayload

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): GetStatusPayload

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

Parameters#

query#

ParsedQs

Returns#

GetStatusPayload