Class ValueOptions

Hierarchy (view full)

CustomTypeClass<ValueOptions>
- ValueOptions

Implements

iValueOptions

Index

Constructors

Properties

expectAddress expectBoolean expectUint expectUri noDuplicates permanentOnceSet

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new ValueOptions(msg): ValueOptions
Parameters
- msg: iValueOptions
Returns ValueOptions
Overrides CustomTypeClass.constructor
- Defined in src/transactions/messages/bitbadges/maps/interfaces.ts:199

Properties

expectAddress

expectAddress: boolean

expectBoolean

expectBoolean: boolean

expectUint

expectUint: boolean

expectUri

expectUri: boolean

noDuplicates

noDuplicates: boolean

permanentOnceSet

permanentOnceSet: boolean

Methods

clone

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

Returns ValueOptions
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:58

convert

convert<U>(_convertFunction?): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional _convertFunction: ((val) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
Returns CustomType<any>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Inherited from CustomTypeClass.convert
- Defined in src/common/base.ts:73

equals

equals<U>(other, normalizeNumberTypes?): 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>
- Optional normalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in src/common/base.ts:54

getNumberFieldNames

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

Returns string[]
Inherited from CustomTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:64

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

toJsonString

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

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