Class: CollectionStatsDoc<T>

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

Extends#

• BaseStatsDoc<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionStatsDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iCollectionStatsDoc<T>

Returns#

CollectionStatsDoc<T>

Overrides#

BaseStatsDoc.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iCollectionStatsDoc._docId

Inherited from#

BaseStatsDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iCollectionStatsDoc._id

Inherited from#

BaseStatsDoc._id

---

collectionId#

collectionId: string

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

The collection ID

Implementation of#

iCollectionStatsDoc.collectionId

---

dailyVolume#

dailyVolume: CosmosCoin<T>[]

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

The daily volume of the collection

Implementation of#

iCollectionStatsDoc.dailyVolume

Inherited from#

BaseStatsDoc.dailyVolume

---

floorPriceHistory?#

optional floorPriceHistory?: FloorPriceHistory<T>[]

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

Floor price history

Implementation of#

iCollectionStatsDoc.floorPriceHistory

---

floorPrices?#

optional floorPrices?: CosmosCoin<T>[]

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

Floor price of the collection

Implementation of#

iCollectionStatsDoc.floorPrices

---

lastUpdatedAt#

lastUpdatedAt: T

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

Last set timestamp

Implementation of#

iCollectionStatsDoc.lastUpdatedAt

Inherited from#

BaseStatsDoc.lastUpdatedAt

---

monthlyVolume#

monthlyVolume: CosmosCoin<T>[]

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

The monthly volume of the collection

Implementation of#

iCollectionStatsDoc.monthlyVolume

Inherited from#

BaseStatsDoc.monthlyVolume

---

overallVolume#

overallVolume: CosmosCoin<T>[]

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

The overall volume of the collection

Implementation of#

iCollectionStatsDoc.overallVolume

Inherited from#

BaseStatsDoc.overallVolume

---

payoutRewards?#

optional payoutRewards?: CosmosCoin<T>[]

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

The payout reward

Implementation of#

iCollectionStatsDoc.payoutRewards

---

uniqueOwners#

uniqueOwners: BalanceArray<T>

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

Number of unique owners by time

Implementation of#

iCollectionStatsDoc.uniqueOwners

---

weeklyVolume#

weeklyVolume: CosmosCoin<T>[]

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

The weekly volume of the collection

Implementation of#

iCollectionStatsDoc.weeklyVolume

Inherited from#

BaseStatsDoc.weeklyVolume

---

yearlyVolume#

yearlyVolume: CosmosCoin<T>[]

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

The yearly volume of the collection

Implementation of#

iCollectionStatsDoc.yearlyVolume

Inherited from#

BaseStatsDoc.yearlyVolume

Methods#

clone()#

clone(): BaseStatsDoc

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

Deep copies the object and returns a new instance.

Returns#

BaseStatsDoc

Inherited from#

BaseStatsDoc.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

CollectionStatsDoc<U>

Overrides#

BaseStatsDoc.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#

BaseStatsDoc.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseStatsDoc.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#

BaseStatsDoc.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#

BaseStatsDoc.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#

BaseStatsDoc.toJsonString