Collection<K, V>

Defined in: packages/client/src/collection.ts:5

A Map with array-like read helpers (find, filter, map, some, every, first, toArray, sorted); every manager's cache (client.contacts, client.channels, …) is one of these.

Extends

• Map<K, V>

Type Parameters

K

K

V

V

Constructors

Constructor

new Collection<K, V>(entries?): Collection<K, V>;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:51

Parameters

entries?

readonly readonly [K, V][] | null

Returns

Collection<K, V>

Inherited from

Map<K, V>.constructor

Constructor

new Collection<K, V>(iterable?): Collection<K, V>;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Parameters

iterable?

Iterable<readonly [K, V], any, any> | null

Returns

Collection<K, V>

Inherited from

Map<K, V>.constructor

Methods

every()

every(predicate): boolean;

Defined in: packages/client/src/collection.ts:32

True if predicate(value, key) holds for every entry (vacuously true when empty).

Parameters

predicate

(value, key) => boolean

Returns

boolean

filter()

filter(predicate): Collection<K, V>;

Defined in: packages/client/src/collection.ts:13

Returns a new Collection with only the entries for which predicate(value, key) is true.

Parameters

predicate

(value, key) => boolean

Returns

Collection<K, V>

find()

find(predicate): V | undefined;

Defined in: packages/client/src/collection.ts:7

Returns the first value for which predicate(value, key) is true, or undefined.

Parameters

predicate

(value, key) => boolean

Returns

V | undefined

first()

first(): V | undefined;

Defined in: packages/client/src/collection.ts:38

The first value in insertion order, or undefined if the collection is empty.

Returns

V | undefined

map()

map<T>(mapper): T[];

Defined in: packages/client/src/collection.ts:20

Applies mapper(value, key) to every entry and returns the results as an array.

Type Parameters

T

T

Parameters

mapper

(value, key) => T

Returns

T[]

some()

some(predicate): boolean;

Defined in: packages/client/src/collection.ts:27

True if predicate(value, key) holds for at least one entry.

Parameters

predicate

(value, key) => boolean

Returns

boolean

sorted()

sorted(compare): V[];

Defined in: packages/client/src/collection.ts:48

All values as a plain array, sorted with compare (same contract as Array.prototype.sort).

Parameters

compare

(a, b) => number

Returns

V[]

toArray()

toArray(): V[];

Defined in: packages/client/src/collection.ts:43

All values as a plain array, in insertion order.

Returns

V[]