Class AssetInfoDoc<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary)

CustomTypeClass<AssetInfoDoc<T>>
- AssetInfoDoc

Implements

iAssetInfoDoc<T>

Index

Constructors

constructor

new AssetInfoDoc<T extends NumberType>(data: iAssetInfoDoc<T>): AssetInfoDoc<T>
Type Parameters
- T extends NumberType
Parameters
- data: iAssetInfoDoc<T>
Returns AssetInfoDoc<T>
Overrides CustomTypeClass.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1798

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

asset

asset: string

lastUpdated

lastUpdated: T

percentageChange24h

percentageChange24h: number

percentageChange7d

percentageChange7d: number

price

price: number

`Optional`recentPriceTrend

recentPriceTrend?: { pricePoints: { price: number; timestamp: T }[] }

Recent price trend data points for charting (last 7 days)

totalLiquidity

totalLiquidity: iCosmosCoin<T>[]

`Optional`verified

verified?: boolean

Whether this asset is verified

volume24h

volume24h: number

volume7d

volume7d: number

Methods

clone

clone(): AssetInfoDoc
Deep copies the object and returns a new instance.

Returns AssetInfoDoc
Inherited from CustomTypeClass.clone
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:105

convert

convert<U extends NumberType>(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): AssetInfoDoc<U>
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns AssetInfoDoc<U>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Overrides CustomTypeClass.convert
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1818

equals

equals<U extends CustomType<U>>(
other: undefined | null | CustomType<U>,
normalizeNumberTypes?: boolean,
): boolean
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 extends CustomType<U>
Parameters
- other: undefined | null | CustomType<U>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:101

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides CustomTypeClass.getNumberFieldNames
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/core/misc.ts:1814

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:115

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:93

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:97