Class QueueDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional _id

_id?: string

A unique document ID (Mongo DB ObjectID)

Optional activityDocId

activityDocId?: string

Optional claimInfo

claimInfo?: {
    body: any;
    claimId: string;
    cosmosAddress: string;
    ip: undefined | string;
    session: any;
}

Type declaration

  • body: any
  • claimId: string
  • cosmosAddress: string
  • ip: undefined | string
  • session: any

collectionId

collectionId: T

The collection ID of the metadata to be fetched

Optional deletedAt

deletedAt?: T

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

Optional emailMessage

emailMessage?: string

Optional error

error?: string

The error message if this metadata failed to be fetched

Optional faucetInfo

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

Type declaration

Optional lastFetchedAt

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

Optional nextFetchTime

nextFetchTime?: T

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

Optional notificationType

notificationType?: string

numRetries

numRetries: T

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

Optional recipientAddress

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>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

toJson

toJsonString

Settings

Member Visibility

Theme

On This Page

constructor_docId_idactivityDocIdclaimInfocollectionIddeletedAtemailMessageerrorfaucetInfolastFetchedAtloadBalanceIdnextFetchTimenotificationTypenumRetriesrecipientAddressrefreshRequestTimeuricloneconvertequalsgetNumberFieldNamestoJsontoJsonString