Interface ICollection<T>

Interface representing a collection of elements.

interface ICollection<T = unknown> {
    capacity: number;
    "[asyncIterator]"(): AsyncIterator<T, any, any>;
    "[iterator]"(): Iterator<Promisable<T>, any, any>;
    clear(): Promisable<void>;
    concat(...items: T[]): MaybeAsyncIterableIterator<T>;
    count(): Promisable<number>;
    remove(
        condition: Predicate<[T]>,
    ): Promisable<MaybeAsyncIterableIterator<T>>;
    removeFirst(condition: Predicate<[T]>): Promisable<boolean>;
    replace(
        condition: Predicate<[T]>,
        newItemFactory: Callable<[T], T>,
    ): Promisable<MaybeAsyncIterableIterator<T>>;
    replaceFirst(condition: Predicate<[T]>, newItem: T): Promisable<boolean>;
}

Type Parameters

T = unknown
The type of elements in the collection.

Hierarchy (View Summary)

Iterable<Promisable<T>>
AsyncIterable<T>
- ICollection

Implemented by

Index

Properties

Methods

[asyncIterator] [iterator] clear concat count remove removeFirst replace replaceFirst

Properties

`Readonly`capacity

capacity: number

The maximum number of elements the collection can hold. If the collection is unbounded, this will be Infinity.

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<T, any, any>
Returns AsyncIterator<T, any, any>
Inherited from AsyncIterable.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:38

[iterator]

"[iterator]"(): Iterator<Promisable<T>, any, any>
Returns Iterator<Promisable<T>, any, any>
Inherited from Iterable.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:49

clear

clear(): Promisable<void>
Removes all elements from the collection.

Returns Promisable<void>
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:32

concat

concat(...items: T[]): MaybeAsyncIterableIterator<T>
Concatenates the given items to the end of the collection and returns an iterator over the merged items.

This method does not mutate the original collection.
Parameters
- ...items: T[]
  The items to merge.
Returns MaybeAsyncIterableIterator<T>
An iterator of the merged items.
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:48

count

count(): Promisable<number>
Returns the number of elements in the collection.

Returns Promisable<number>
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:37

remove

remove(condition: Predicate<[T]>): Promisable<MaybeAsyncIterableIterator<T>>
Removes all the items matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to remove.
Returns Promisable<MaybeAsyncIterableIterator<T>>
An iterable of the removed items.
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:64

removeFirst

removeFirst(condition: Predicate<[T]>): Promisable<boolean>
Removes the first occurrence of the item matching the given predicate from the collection.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to remove.
Returns Promisable<boolean>
true if the item was found and removed, false otherwise.
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:56

replace

replace(
condition: Predicate<[T]>,
newItemFactory: Callable<[T], T>,
): Promisable<MaybeAsyncIterableIterator<T>>
Replaces all the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the items to replace.
- newItemFactory: Callable<[T], T>
  A function that takes the old item and returns the new item to insert.
Returns Promisable<MaybeAsyncIterableIterator<T>>
An iterable of the replaced items.
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:82

replaceFirst

replaceFirst(condition: Predicate<[T]>, newItem: T): Promisable<boolean>
Replaces the first occurence of the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[T]>
  A predicate function to identify the item to replace.
- newItem: T
  The new item to insert.
Returns Promisable<boolean>
true if the item was found and replaced, false otherwise.
- Defined in packages/misc-util/src/data/abstract-types/icollection.ts:73