Class GenerationalArena<T, I>

A SyncArena that uses generational index as key.

Type Parameters

T
I extends number = number

Hierarchy

SyncMapBatchAdapter<I, T>
- GenerationalArena

Implements

SyncArena<I, T>
MaybeAsyncMapBatch<I, T>
Map<I, T>
Iterable<[I, T]>
KeyValueIterable<I, T>

Index

Constructors

Properties

Accessors

[toStringTag] size

Methods

[iterator] add clear delete deleteMany entries forEach get getMany has hasMany keys set setMany updateMany values

Constructors

constructor

new GenerationalArena<T, I>(): GenerationalArena<T, I>
Type Parameters
- T
- I extends number = number
Returns GenerationalArena<T, I>
Inherited from SyncMapBatchAdapter<I, T>.constructor

Properties

`Private` `Readonly` data

data: T[] = []

`Private` ids

ids: IdGenerator<I> = ...

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of Map.[toStringTag]
- Defined in collections/src/generational/arena.ts:80

size

get size(): number
Returns number
Implementation of Map.size
- Defined in collections/src/generational/arena.ts:16

Methods

[iterator]

[iterator](): IterableIterator<[I, T]>
Returns IterableIterator<[I, T]>
Implementation of Map.[iterator]
- Defined in collections/src/generational/arena.ts:76

add

add(value): I
Adds a value to the arena and returns its key.
Parameters
- value: T
Returns I
Implementation of SyncArena.add
- Defined in collections/src/generational/arena.ts:20

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in collections/src/generational/arena.ts:26

delete

delete(id): boolean
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- id: I
Returns boolean
Implementation of SyncArena.delete
Overrides SyncMapBatchAdapter.delete
- Defined in collections/src/generational/arena.ts:31

deleteMany

deleteMany(keys, options?): IterableIterator<undefined | CodedError<I, unknown>>
Deletes the values with given keys.
Parameters
- keys: Iterable<I>
- Optional options: AbortOptions
Returns IterableIterator<undefined | CodedError<I, unknown>>
Implementation of MaybeAsyncMapBatch.deleteMany
Inherited from SyncMapBatchAdapter.deleteMany
- Defined in collections/src/impl/batchmap.ts:41

entries

entries(): IterableIterator<[I, T]>
Queries key-value pairs by given criteria.

Returns IterableIterator<[I, T]>
Implementation of KeyValueIterable.entries
- Defined in collections/src/generational/arena.ts:60

forEach

forEach(callback, thisArg?): void
Parameters
- callback: ((value, key, self) => void)
  - - (value, key, self): void
    - Parameters
      value: T
      key: I
      self: GenerationalArena<T, I>
      Returns void
- Optional thisArg: unknown
Returns void
Implementation of Map.forEach
- Defined in collections/src/generational/arena.ts:54

get

get(id): undefined | T
Gets a value by key from the map.
Parameters
- id: I
Returns undefined | T
Implementation of SyncArena.get
Overrides SyncMapBatchAdapter.get
- Defined in collections/src/generational/arena.ts:39

getMany

getMany(keys, options?): IterableIterator<undefined | T>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<I>
- Optional options: AbortOptions
Returns IterableIterator<undefined | T>
Implementation of MaybeAsyncMapBatch.getMany
Inherited from SyncMapBatchAdapter.getMany
- Defined in collections/src/impl/batchmap.ts:11

has

has(id): boolean
Returns whether a key exists in the map.
Parameters
- id: I
Returns boolean
Implementation of SyncArena.has
Overrides SyncMapBatchAdapter.has
- Defined in collections/src/generational/arena.ts:43

hasMany

hasMany(keys, options?): IterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<I>
- Optional options: AbortOptions
Returns IterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
Inherited from SyncMapBatchAdapter.hasMany
- Defined in collections/src/impl/batchmap.ts:18

keys

keys(): IterableIterator<I>
Queries keys by given criteria.

Returns IterableIterator<I>
Implementation of KeyValueIterable.keys
- Defined in collections/src/generational/arena.ts:66

set

set(id, value): GenerationalArena<T, I>
Updates a value on the arena. Does nothing if the key does not exist.
Parameters
- id: I
- value: T
Returns GenerationalArena<T, I>
Implementation of SyncArena.set
Overrides SyncMapBatchAdapter.set
- Defined in collections/src/generational/arena.ts:47

setMany

setMany(entries, options?): IterableIterator<undefined | CodedError<I, unknown>>
Sets given list of entries.
Parameters
- entries: Iterable<[I, T]>
- Optional options: AbortOptions
Returns IterableIterator<undefined | CodedError<I, unknown>>
Implementation of MaybeAsyncMapBatch.setMany
Inherited from SyncMapBatchAdapter.setMany
- Defined in collections/src/impl/batchmap.ts:25

updateMany

updateMany(entries, options?): IterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[I, T?]>
- Optional options: AbortOptions
Returns IterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.updateMany
Inherited from SyncMapBatchAdapter.updateMany
- Defined in collections/src/impl/batchmap.ts:57

values

values(): IterableIterator<T>
Queries values by given criteria.

Returns IterableIterator<T>
Implementation of KeyValueIterable.values
- Defined in collections/src/generational/arena.ts:70

Generated using TypeDoc