Class BatchBadgeDetailsArray<T>

Type Parameters

T extends NumberType

Hierarchy

BaseTypedArray<BatchBadgeDetailsArray<T>, BatchBadgeDetails<T>>
- BatchBadgeDetailsArray

Index

Constructors

constructor

Methods

add convert getPage isSubsetOf noneIn remove From

Constructors

constructor

new BatchBadgeDetailsArray<T>(arrayLength): BatchBadgeDetailsArray<T>
Type Parameters
- T extends NumberType
Parameters
- arrayLength: number
Returns BatchBadgeDetailsArray<T>
Inherited from BaseTypedArray<BatchBadgeDetailsArray<T>, BatchBadgeDetails<T>>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1508
new BatchBadgeDetailsArray<T>(...items): BatchBadgeDetailsArray<T>
Type Parameters
- T extends NumberType
Parameters
- Rest ...items: BatchBadgeDetails<T>[]
Returns BatchBadgeDetailsArray<T>
Inherited from BaseTypedArray<BatchBadgeDetailsArray<T>, BatchBadgeDetails<T>>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1509

Methods

add

add(other): void
Adds badge details to the batch details array. If the collectionId already exists, it will merge the badgeIds.
Parameters
- other: BatchBadgeDetailsArray<T> | iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[]
Returns void
- Defined in src/core/batch-utils.ts:131

convert

convert<U>(convertFunction): BatchBadgeDetailsArray<U>
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns BatchBadgeDetailsArray<U>
- Defined in src/core/batch-utils.ts:124

getPage

getPage(_pageNumber, _pageSize, sortBy?): BatchBadgeDetailsArray<T>
Get specific badges for the batch details. Useful for displaying badges on a page.

Assums that badgeIds are sorted, merged, and non-overlapping.
Parameters
- _pageNumber: number
- _pageSize: number
- Optional sortBy: "newest" | "oldest"
Returns BatchBadgeDetailsArray<T>
- Defined in src/core/batch-utils.ts:199

isSubsetOf

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

noneIn

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

remove

remove(other): void
Removes badge details from the batch details array. If the collectionId already exists, it will remove the badgeIds.
Parameters
- other: BatchBadgeDetailsArray<T> | iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[]
Returns void
- Defined in src/core/batch-utils.ts:158

`Static` From

From<T>(arr): BatchBadgeDetailsArray<T>
Type Parameters
- T extends NumberType
Parameters
- arr: iBatchBadgeDetails<T> | iBatchBadgeDetails<T>[] | BatchBadgeDetailsArray<T>
Returns BatchBadgeDetailsArray<T>
- Defined in src/core/batch-utils.ts:91

Class BatchBadgeDetailsArray<T>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BatchBadgeDetailsArray<T>

Type Parameters

Parameters

Returns BatchBadgeDetailsArray<T>

Methods

add

Parameters

Returns void

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BatchBadgeDetailsArray<U>

getPage

Parameters

Returns BatchBadgeDetailsArray<T>

isSubsetOf

Parameters

Returns boolean

noneIn

Parameters

Returns boolean

remove

Parameters

Returns void

Static From

Type Parameters

Parameters

Returns BatchBadgeDetailsArray<T>

Settings

Member Visibility

Theme

On This Page

`Static` From