Skip to content

Interface: iFetchDoc<T>

T extends NumberType

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

Extends

Type Parameters

T

T extends NumberType

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from

Doc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from

Doc._id

content?

optional content?: iApprovalInfoDetails | iMetadata<T> | iOffChainBalancesMap<T> | iChallengeDetails<T>

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

The content of the fetch document. Note that we store balances in BALANCES_DB and not here to avoid double storage.

db

db: "ApprovalInfo" | "Metadata" | "Balances" | "ChallengeInfo"

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

The type of content fetched. This is used for querying purposes

fetchedAt

fetchedAt: T

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

The time the document was fetched

fetchedAtBlock

fetchedAtBlock: T

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

The block the document was fetched

isPermanent

isPermanent: boolean

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

True if the document is permanent (i.e. fetched from a permanent URI like IPFS)

Edit this page on GitHub