Class BatchBadgeDetails<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<BatchBadgeDetails<T>>
- BatchBadgeDetails

Implements

iBatchBadgeDetails<T>

Index

Constructors

Properties

badgeIds collectionId

Methods

clone convert doesNotOverlap equals getNumberFieldNames isSubsetOf noneIn toArray toJson toJsonString

Constructors

constructor

new BatchBadgeDetails<T>(data): BatchBadgeDetails<T>
Type Parameters
- T extends NumberType
Parameters
- data: iBatchBadgeDetails<T>
Returns BatchBadgeDetails<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/batch-utils.ts:27

Properties

badgeIds

badgeIds: UintRangeArray<T>

The corresponding badge IDs for this collection ID.

collectionId

collectionId: T

The collection ID of this element's badge details.

Methods

clone

clone(): BatchBadgeDetails<T>
Deep copies the object and returns a new instance.

Returns BatchBadgeDetails<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:100

convert

convert<U>(convertFunction): BatchBadgeDetails<U>
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns BatchBadgeDetails<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/core/batch-utils.ts:37

doesNotOverlap

doesNotOverlap(other): boolean
Checks if the badge details overlap with another set of badge details.
Parameters
- other: iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[]
Returns boolean
- Defined in src/core/batch-utils.ts:48

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>
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:96

getNumberFieldNames

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

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/core/batch-utils.ts:33

isSubsetOf

isSubsetOf(other): boolean
Checks if the badge details are a subset of another set of badge details (i.e. all badgeIds are in the other set).
Parameters
- other: iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[]
Returns boolean
- Defined in src/core/batch-utils.ts:60

noneIn

noneIn(other): boolean
Checks if the badge details are not in another set of badge details (i.e. none of the badgeIds are in the other set).
Parameters
- other: iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[]
Returns boolean
- Defined in src/core/batch-utils.ts:73

toArray

toArray(): BatchBadgeDetailsArray<T>
Returns BatchBadgeDetailsArray<T>
- Defined in src/core/batch-utils.ts:82

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:88

toJsonString

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

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:92