Class QueueDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_docId _id? actionConfig? activityDocId? claimInfo? collectionId deletedAt? emailMessage? error? faucetInfo? initiatedBy? lastFetchedAt? loadBalanceId nextFetchTime? notificationType? numRetries pending? recipientAddress? refreshRequestTime uri

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

OptionalactionConfig

actionConfig?: any

OptionalactivityDocId

activityDocId?: string

OptionalclaimInfo

claimInfo?: {
    bitbadgesAddress: string;
    body: any;
    claimId: string;
    ip: undefined | string;
    session: any;
    [key: string]: any;
}

collectionId

collectionId: T

The collection ID of the metadata to be fetched

OptionaldeletedAt

deletedAt?: T

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

OptionalemailMessage

emailMessage?: string

Optionalerror

error?: string

The error message if this metadata failed to be fetched

OptionalfaucetInfo

faucetInfo?: {
    amount: NumberType;
    denom: string;
    recipient: string;
    txHash: string;
}

OptionalinitiatedBy

initiatedBy?: string

The BitBadges address of the user who initiated this fetch

OptionallastFetchedAt

lastFetchedAt?: T

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

loadBalanceId

loadBalanceId: T

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

OptionalnextFetchTime

nextFetchTime?: T

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

OptionalnotificationType

notificationType?: string

numRetries

numRetries: T

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

Optionalpending

pending?: boolean

Whether this document is pending to be fetched or not

OptionalrecipientAddress

recipientAddress?: string

refreshRequestTime

refreshRequestTime: T

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

uri

uri: string

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

Methods

clone

convert

equals

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

  • 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

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

hasNumberFields

toJson

toJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods