Class: DynamicStoreDocWithDetails<T>

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

DynamicStoreDocWithDetails extends DynamicStoreDoc with populated metadata.

Extends#

• BaseNumberTypeClass<DynamicStoreDocWithDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iDynamicStoreDocWithDetails<T>

Constructors#

Constructor#

new DynamicStoreDocWithDetails<T>(doc): DynamicStoreDocWithDetails<T>

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

Parameters#

doc#

iDynamicStoreDocWithDetails<T>

Returns#

DynamicStoreDocWithDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iDynamicStoreDocWithDetails._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iDynamicStoreDocWithDetails._id

---

createdBy#

createdBy: string

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

Implementation of#

iDynamicStoreDocWithDetails.createdBy

---

customData?#

optional customData?: string

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

Implementation of#

iDynamicStoreDocWithDetails.customData

---

defaultValue#

defaultValue: boolean

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

Implementation of#

iDynamicStoreDocWithDetails.defaultValue

---

globalEnabled#

globalEnabled: boolean

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

Implementation of#

iDynamicStoreDocWithDetails.globalEnabled

---

metadata?#

optional metadata?: Metadata<T>

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

Implementation of#

iDynamicStoreDocWithDetails.metadata

---

storeId#

storeId: T

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

Implementation of#

iDynamicStoreDocWithDetails.storeId

---

uri?#

optional uri?: string

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

Implementation of#

iDynamicStoreDocWithDetails.uri

Methods#

clone()#

clone(): DynamicStoreDocWithDetails

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

Deep copies the object and returns a new instance.

Returns#

DynamicStoreDocWithDetails

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

DynamicStoreDocWithDetails<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:2241

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