Class: AliasPath<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:956

Extends#

• CustomTypeClass<AliasPath<T>>

Extended by#

• AliasPathWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iAliasPath<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:963

Parameters#

data#

iAliasPath<T>

Returns#

AliasPath<T>

Overrides#

CustomTypeClass.constructor

Properties#

conversion#

conversion: ConversionWithoutDenom<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:958

Implementation of#

iAliasPath.conversion

---

denom#

denom: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:957

Implementation of#

iAliasPath.denom

---

denomUnits#

denomUnits: DenomUnit<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:960

Implementation of#

iAliasPath.denomUnits

---

metadata#

metadata: PathMetadata

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:961

The metadata for this alias path.

Implementation of#

iAliasPath.metadata

---

symbol#

symbol: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:959

Implementation of#

iAliasPath.symbol

Methods#

clone()#

clone(): AliasPath

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

Deep copies the object and returns a new instance.

Returns#

AliasPath

Inherited from#

CustomTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:976

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

AliasPath<U>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Overrides#

CustomTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:972

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

Returns#

string[]

Overrides#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString

---

fromProto()#

static fromProto<U>(protoMsg, convertFunction): AliasPath<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:980

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

AliasPath

convertFunction#

(item) => U

Returns#

AliasPath<U>