Class: ListingViewsDoc<T>

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

Extends#

• BaseNumberTypeClass<ListingViewsDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iListingViewsDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iListingViewsDoc<T>

Returns#

ListingViewsDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

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

A unique stringified document ID

Implementation of#

iListingViewsDoc._docId

---

_id?#

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of#

iListingViewsDoc._id

---

lastUpdated#

lastUpdated: T

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

The last time this view count was updated

Implementation of#

iListingViewsDoc.lastUpdated

---

listingId#

listingId: string

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

The listing ID this view count is for

Implementation of#

iListingViewsDoc.listingId

---

viewCount#

viewCount: T

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

The total number of views

Implementation of#

iListingViewsDoc.viewCount

---

viewsByPeriod?#

optional viewsByPeriod?: object

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

Optional breakdown of views by time period for trending calculations

daily#

daily: number

hourly#

hourly: number

monthly#

monthly: number

weekly#

weekly: number

Implementation of#

iListingViewsDoc.viewsByPeriod

Methods#

clone()#

clone(): ListingViewsDoc

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

Deep copies the object and returns a new instance.

Returns#

ListingViewsDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ListingViewsDoc<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:1220

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