Skip to content

Base class that implements the CustomType interface. It provides default implementations for all methods. This is to be used when the class and all of its…

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

Base class that implements the CustomType interface. It provides default implementations for all methods. This is to be used when the class and all of its fields are of primitive types (i.e. no number types).

Extended by

Type Parameters

T

T extends CustomType<T>

Implements

Constructors

Constructor

new CustomTypeClass<T>(): CustomTypeClass<T>

Returns

CustomTypeClass<T>

Methods

clone()

clone(): T

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

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:124

Type Parameters

U

U extends NumberType

Parameters

_convertFunction?

(val) => U

options?

ConvertOptions

Returns

CustomType<any>

Deprecated

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

Implementation of

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

Implementation of

CustomType.equals


getNumberFieldNames()

getNumberFieldNames(): string[]

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

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:115

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:93

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:97

Converts the object to a JSON string.

Returns

string

Implementation of

CustomType.toJsonString

Edit this page on GitHub