Class EstimatedCost<T>

A cost estimate with an amount and denomination, similar to CosmosCoin but for display purposes only.

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

CustomTypeClass<EstimatedCost<T>>
- EstimatedCost

Implements

iEstimatedCost<T>

Index

Constructors

Properties

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

new EstimatedCost<T extends NumberType>(
data: iEstimatedCost<T>,
): EstimatedCost<T>
Type Parameters
- T extends NumberType
Parameters
- data: iEstimatedCost<T>
Returns EstimatedCost<T>
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/docs/docs.ts:1221

Properties

amount

amount: T

The amount of the cost

denom

denom: string

The denomination of the cost (e.g. 'USD', 'ETH', etc.)

Methods

clone

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

Returns EstimatedCost
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:105

convert

convert<U extends NumberType>(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): EstimatedCost<U>
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns EstimatedCost<U>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Overrides CustomTypeClass.convert
- Defined in src/api-indexer/docs/docs.ts:1231

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 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 src/api-indexer/docs/docs.ts:1227

hasNumberFields

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

Returns boolean
Inherited from CustomTypeClass.hasNumberFields
- Defined in 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 src/common/base.ts:93

toJsonString

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

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:97