Class AssetPriceHistoryDoc<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary)

BaseNumberTypeClass<AssetPriceHistoryDoc<T>>
- AssetPriceHistoryDoc

Implements

iAssetPriceHistoryDoc<T>

Index

Constructors

Properties

_docId _id? asset high? low? open? price timeframe timestamp totalLiquidity

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new AssetPriceHistoryDoc<T extends NumberType>(
doc: iAssetPriceHistoryDoc<T>,
): AssetPriceHistoryDoc<T>
Type Parameters
- T extends NumberType
Parameters
- doc: iAssetPriceHistoryDoc<T>
Returns AssetPriceHistoryDoc<T>
Overrides BaseNumberTypeClass.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/gamm/indexer.ts:127

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

asset

asset: string

`Optional`high

high?: number

`Optional`low

low?: number

`Optional`open

open?: number

price

price: number

timeframe

timeframe: string

timestamp

timestamp: T

totalLiquidity

totalLiquidity: CosmosCoin<T>[]

Methods

clone

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

Returns AssetPriceHistoryDoc
Inherited from BaseNumberTypeClass.clone
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:151

convert

convert<U extends NumberType>(
convertFunction: (val: NumberType) => U,
options?: { keepOriginalObject: boolean },
): AssetPriceHistoryDoc<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (val: NumberType) => U
- Optionaloptions: { keepOriginalObject: boolean }
Returns AssetPriceHistoryDoc<U>
Overrides BaseNumberTypeClass.convert
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/gamm/indexer.ts:145

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 BaseNumberTypeClass.equals
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:147

getNumberFieldNames

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

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/gamm/indexer.ts:141

hasNumberFields

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

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

toJson

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

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

toJsonString

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

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