Skip to content

Class: QueueDoc<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:605

Extends

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:639

Parameters

data

iQueueDoc<T>

Returns

QueueDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:609

A unique stringified document ID

Implementation of

iQueueDoc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:610

A unique document ID (Mongo DB ObjectID)

Implementation of

iQueueDoc._id

actionConfig?

optional actionConfig?: any

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:636

For use for post-claim actions

Implementation of

iQueueDoc.actionConfig

activityDocId?

optional activityDocId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:623

Implementation of

iQueueDoc.activityDocId

claimInfo?

optional claimInfo?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:625

For use for claim completion

Index Signature

[key: string]: any

bitbadgesAddress

bitbadgesAddress: string

body

body: any

claimId

claimId: string

ip

ip: string | undefined

session

session: any

Implementation of

iQueueDoc.claimInfo

collectionId

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:612

The collection ID of the metadata to be fetched

Implementation of

iQueueDoc.collectionId

deletedAt?

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:619

The timestamp of when this document was deleted (milliseconds since epoch)

Implementation of

iQueueDoc.deletedAt

emailMessage?

optional emailMessage?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:621

Implementation of

iQueueDoc.emailMessage

error?

optional error?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:618

The error message if this metadata failed to be fetched

Implementation of

iQueueDoc.error

faucetInfo?

optional faucetInfo?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:635

For use for airdrops

amount

amount: NumberType

denom

denom: string

recipient

recipient: string

txHash

txHash: string

Implementation of

iQueueDoc.faucetInfo

initiatedBy?

optional initiatedBy?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:637

The BitBadges address of the user who initiated this fetch

Implementation of

iQueueDoc.initiatedBy

lastFetchedAt?

optional lastFetchedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:617

The timestamp of when this metadata was last fetched (milliseconds since epoch)

Implementation of

iQueueDoc.lastFetchedAt

loadBalanceId

loadBalanceId: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:613

The load balance ID of the metadata to be fetched. Only the node with the same load balance ID will fetch this metadata

Implementation of

iQueueDoc.loadBalanceId

nextFetchTime?

optional nextFetchTime?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:620

The timestamp of when this document should be fetched next (milliseconds since epoch)

Implementation of

iQueueDoc.nextFetchTime

notificationType?

optional notificationType?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:624

Type of the doc / purpose

Implementation of

iQueueDoc.notificationType

numRetries

numRetries: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:616

The number of times this metadata has been tried to be fetched but failed

Implementation of

iQueueDoc.numRetries

pending?

optional pending?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:614

Whether this document is pending to be fetched or not

Implementation of

iQueueDoc.pending

queueClaimId?

optional queueClaimId?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:607

Identity of the worker claim for this generation.

Implementation of

iQueueDoc.queueClaimId

queueGeneration?

optional queueGeneration?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:606

Identity of the current requested queue work.

Implementation of

iQueueDoc.queueGeneration

queueLeaseUntil?

optional queueLeaseUntil?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:608

Expiration of the worker lease in milliseconds since epoch.

Implementation of

iQueueDoc.queueLeaseUntil

recipientAddress?

optional recipientAddress?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:622

Implementation of

iQueueDoc.recipientAddress

refreshRequestTime

refreshRequestTime: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:615

The timestamp of when this metadata was requested to be refreshed (milliseconds since epoch)

Implementation of

iQueueDoc.refreshRequestTime

uri

uri: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:611

The URI of the metadata to be fetched. If {id} is present, it will be replaced with each individual ID in tokenIds

Implementation of

iQueueDoc.uri

Methods

clone()

clone(): QueueDoc

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

Deep copies the object and returns a new instance.

Returns

QueueDoc

Inherited from

BaseNumberTypeClass.clone

convert()

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:670

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

QueueDoc<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/docs-types/docs.ts:666

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

Edit this page on GitHub