Skip to content

Base class that implements the CustomType interface. It provides default implementations for all methods.

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

Base class that implements the CustomType interface. It provides default implementations for all methods.

IMPORTANT: You must implement the getNumberFieldNames method yourself for this class to work properly. Also, you will need to implement the convert method yourself if you want to use it in a typed manner. This can be done by simply calling convertClassPropertiesAndMaintainNumberTypes(this, convertFunction, options) and casting the result to the correct type.

Extended by

Type Parameters

T

T extends CustomType<T>

Implements

Constructors

Constructor

new BaseNumberTypeClass<T>(): BaseNumberTypeClass<T>

Returns

BaseNumberTypeClass<T>

Methods

clone()

clone(): T

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

Deep copies the object and returns a new instance.

Returns

T

Implementation of

CustomType.clone


convert()

convert<U>(convertFunction, options?): CustomType<any>

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

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(val) => U

options?

ConvertOptions

Returns

CustomType<any>

Implementation of

CustomType.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

Implementation of

CustomType.equals


getNumberFieldNames()

getNumberFieldNames(): string[]

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

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

Returns

string[]

Implementation of

CustomType.getNumberFieldNames


hasNumberFields()

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns

boolean

Implementation of

CustomType.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

Implementation of

CustomType.toJson


toJsonString()

toJsonString(): string

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

Converts the object to a JSON string.

Returns

string

Implementation of

CustomType.toJsonString

Edit this page on GitHub