Class: DynamicDataDoc<Q, T>

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

Extends#

• BaseNumberTypeClass<DynamicDataDoc<Q, T>>

Type Parameters#

Q#

Q extends DynamicDataHandlerType

T#

T extends NumberType

Implements#

• iDynamicDataDoc<Q, T>

Constructors#

Constructor#

new DynamicDataDoc<Q, T>(data): DynamicDataDoc<Q, T>

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

Parameters#

data#

iDynamicDataDoc<Q, T>

Returns#

DynamicDataDoc<Q, T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iDynamicDataDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iDynamicDataDoc._id

---

createdAt?#

optional createdAt?: T

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

The time the dynamic data store was created

Implementation of#

iDynamicDataDoc.createdAt

---

createdBy#

createdBy: string

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

The creator of the dynamic data store

Implementation of#

iDynamicDataDoc.createdBy

---

data#

data: DynamicDataHandlerData<Q>

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

The data itself.

Implementation of#

iDynamicDataDoc.data

---

dataSecret#

dataSecret: string

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

The data secret. Used in cases where you are not signed in as creator. This authenticates the request. Not applicable to public stores

Implementation of#

iDynamicDataDoc.dataSecret

---

dynamicDataId#

dynamicDataId: string

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

The dynamic data ID. The ID of the store.

Implementation of#

iDynamicDataDoc.dynamicDataId

---

handlerId#

handlerId: Q

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

The handler ID. Can also be thought of as the type of dynamic data ("addresses", "email", ...)

Implementation of#

iDynamicDataDoc.handlerId

---

label#

label: string

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

The label of the data store

Implementation of#

iDynamicDataDoc.label

---

lastUpdated?#

optional lastUpdated?: T

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

The time the dynamic data store was last updated

Implementation of#

iDynamicDataDoc.lastUpdated

---

managedBy#

managedBy: string

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

The manager of the dynamic data store

Implementation of#

iDynamicDataDoc.managedBy

---

publicUseInClaims?#

optional publicUseInClaims?: boolean

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

Whether the dynamic data store is public. If true, the data can be accessed without authentication.

Implementation of#

iDynamicDataDoc.publicUseInClaims

Methods#

clone()#

clone(): DynamicDataDoc<Q, T>

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

Deep copies the object and returns a new instance.

Returns#

DynamicDataDoc<Q, T>

Overrides#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): DynamicDataDoc<Q, U>

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

DynamicDataDoc<Q, 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:1862

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