Class: FetchDoc<T>

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

Extends#

• BaseNumberTypeClass<FetchDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iFetchDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iFetchDoc<T>

Returns#

FetchDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iFetchDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iFetchDoc._id

---

content?#

optional content?: Metadata<T> | ApprovalInfoDetails<T> | {[bitbadgesAddressOrListId: string]: BalanceArray<T>; } | ChallengeDetails<T>

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

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

Implementation of#

iFetchDoc.content

---

db#

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

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

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

Implementation of#

iFetchDoc.db

---

fetchedAt#

fetchedAt: T

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

The time the document was fetched

Implementation of#

iFetchDoc.fetchedAt

---

fetchedAtBlock#

fetchedAtBlock: T

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

The block the document was fetched

Implementation of#

iFetchDoc.fetchedAtBlock

---

isPermanent#

isPermanent: boolean

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

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

Implementation of#

iFetchDoc.isPermanent

Methods#

clone()#

clone(): FetchDoc

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

Deep copies the object and returns a new instance.

Returns#

FetchDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

FetchDoc<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:1616

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