Class IdGenerator<T>

SyncGenerator of generational index IDs.

Type Parameters

T extends number = number

Implements

SyncGenerator<T>
ReadonlySet<T>
Iterable<T>
KeyValueIterable<T, T>

Index

Constructors

Properties

freeList generations

Accessors

[toStringTag] size

Methods

[iterator] clear create delete entries forEach has keys values

Constructors

constructor

new IdGenerator<T>(): IdGenerator<T>
Type Parameters
- T extends number = number
Returns IdGenerator<T>

Properties

`Private` `Readonly` freeList

freeList: number[] = []

`Private` `Readonly` generations

generations: number[] = []

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in collections/src/generational/generator.ts:91

size

get size(): number
Returns number
Implementation of ReadonlySet.size
- Defined in collections/src/generational/generator.ts:12

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
Implementation of ReadonlySet.[iterator]
- Defined in collections/src/generational/generator.ts:87

clear

clear(): void
Returns void
- Defined in collections/src/generational/generator.ts:16

create

create(): T
Creates a new value.

Returns T
Implementation of SyncGenerator.create
- Defined in collections/src/generational/generator.ts:21

delete

delete(id): boolean
Deletes a value.
Parameters
- id: T
Returns boolean
Implementation of SyncGenerator.delete
- Defined in collections/src/generational/generator.ts:39

entries

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

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

forEach

forEach(callback, thisArg?): void
Parameters
- callback: ((value, value2, self) => void)
  - - (value, value2, self): void
    - Parameters
      value: T
      value2: T
      self: IdGenerator<T>
      Returns void
- Optional thisArg: unknown
Returns void
Implementation of ReadonlySet.forEach
- Defined in collections/src/generational/generator.ts:62

has

has(id): boolean
Returns whether a value exists in the set.
Parameters
- id: T
Returns boolean
Implementation of SyncGenerator.has
- Defined in collections/src/generational/generator.ts:57

keys

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

Returns IterableIterator<T>
Implementation of KeyValueIterable.keys
- Defined in collections/src/generational/generator.ts:74

values

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

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

Generated using TypeDoc