Class default<TKey, TValue>

A collection for registering values by key. This base class is intended to facilitate specialized control. Sub-classes control how items are added.

Type Parameters

TKey
TValue

Hierarchy

OrderedRegistryBase<TKey, TValue>
- default

Index

Constructors

Accessors

isEmpty keys reversed values version

Methods

_addInternal _getIterator _setInternal add assertVersion clear contains dispose get getCount getFirstKeyOf has incrementVersion register remove set takeFirst takeLast

Constructors

constructor

new default<TKey, TValue>(): default<TKey, TValue>
Type Parameters
- TKey
- TValue
Returns default<TKey, TValue>
Overrides OrderedRegistryBase.constructor
- Defined in OrderedRegistry.ts:295

Accessors

isEmpty

get isEmpty(): boolean
Returns true if there are no entries.

Returns

Returns boolean
Inherited from OrderedRegistryBase.isEmpty
- Defined in OrderedRegistry.ts:154

keys

get keys(): ExtendedIterable<TKey>
Returns an in-order iterable of all keys.

Returns ExtendedIterable<TKey>
Inherited from OrderedRegistryBase.keys
- Defined in OrderedRegistry.ts:51

reversed

get reversed(): ExtendedIterable<KeyValuePair<TKey, TValue>>
Iterable for iterating this collection in reverse order.

Returns

Returns ExtendedIterable<KeyValuePair<TKey, TValue>>
Inherited from OrderedRegistryBase.reversed
- Defined in OrderedRegistry.ts:82

values

get values(): ExtendedIterable<TValue>
Returns an in-order iterable of all values.

Returns ExtendedIterable<TValue>
Inherited from OrderedRegistryBase.values
- Defined in OrderedRegistry.ts:65

version

get version(): number
The version number used to track changes.

Returns

Returns number
Inherited from OrderedRegistryBase.version
- Defined in OrderedRegistry.ts:97

Methods

`Protected` _addInternal

_addInternal(key: TKey, value: TValue): default<TKey, TValue>
Add an entry to the end of the registry.

Throws
If key is null.

Throws
If key already exists.

Returns
Parameters
- key: TKey
- value: TValue
Returns default<TKey, TValue>
Inherited from OrderedRegistryBase._addInternal
- Defined in OrderedRegistry.ts:200

`Protected` _getIterator

_getIterator(): Iterator<KeyValuePair<TKey, TValue>, any, undefined>
Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>
Inherited from OrderedRegistryBase._getIterator
- Defined in OrderedRegistry.ts:285

`Protected` _setInternal

_setInternal(key: TKey, value: TValue): boolean
Updates or adds a value.

Returns
True if the value was added or changed. False if no change.
Parameters
- key: TKey
- value: TValue
Returns boolean
Inherited from OrderedRegistryBase._setInternal
- Defined in OrderedRegistry.ts:219

add

add(key: TKey, value: TValue): default<TKey, TValue>
Add an entry to the end of the registry.

Throws
If key is null.

Throws
If key already exists.

Returns
Parameters
- key: TKey
- value: TValue
Returns default<TKey, TValue>
- Defined in OrderedRegistry.ts:308

assertVersion

assertVersion(version: number): true
Throws if the provided version does not match the current one.

Returns
Parameters
- version: number
Returns true
Inherited from OrderedRegistryBase.assertVersion
- Defined in OrderedRegistry.ts:107

clear

clear(): number
Clears all entries.

Returns
The number entries cleared.

Returns number
Inherited from OrderedRegistryBase.clear
- Defined in OrderedRegistry.ts:126

contains

contains(entry: KeyValuePair<TKey, TValue>): boolean
Returns true if the key exists and the value matches exactly.

Returns
Parameters
- entry: KeyValuePair<TKey, TValue>
Returns boolean
Inherited from OrderedRegistryBase.contains
- Defined in OrderedRegistry.ts:164

dispose

dispose(): void
Clears the collection. Provided for compatibility with disposal routines.

Returns void
Inherited from OrderedRegistryBase.dispose
- Defined in OrderedRegistry.ts:136

get

get(key: TKey): undefined | TValue
Returns the value if it exists. Otherwise undefined.

Returns
Parameters
- key: TKey
Returns undefined | TValue
Inherited from OrderedRegistryBase.get
- Defined in OrderedRegistry.ts:187

getCount

getCount(): number
Gets the number of entries.

Returns

Returns number
Inherited from OrderedRegistryBase.getCount
- Defined in OrderedRegistry.ts:145

getFirstKeyOf

getFirstKeyOf(value: TValue): undefined | TKey
Finds the entry and returns its Id.
Parameters
- value: TValue
Returns undefined | TKey
Inherited from OrderedRegistryBase.getFirstKeyOf
- Defined in OrderedRegistry.ts:276

has

has(key: TKey): boolean
Returns true

Returns
Parameters
- key: TKey
Returns boolean
Inherited from OrderedRegistryBase.has
- Defined in OrderedRegistry.ts:177

incrementVersion

incrementVersion(): number
Increments the collection version. Useful for tracking changes.

Returns
The new version.

Returns number
Inherited from OrderedRegistryBase.incrementVersion
- Defined in OrderedRegistry.ts:117

register

register(key: TKey, value: TValue): boolean
Adds an entry to the registry if it doesn't exist. Returns true if the key did not exist and the entry was added. Returns false if the key already exists.

Returns
Parameters
- key: TKey
- value: TValue
Returns boolean
- Defined in OrderedRegistry.ts:333

remove

remove(key: TKey): undefined | TValue
Removes an entry and returns its value if found.
Parameters
- key: TKey
Returns undefined | TValue
Inherited from OrderedRegistryBase.remove
- Defined in OrderedRegistry.ts:239

set

set(key: TKey, value: TValue): boolean
Updates or adds a value.

Returns
True if the value was added or changed. False if no change.
Parameters
- key: TKey
- value: TValue
Returns boolean
- Defined in OrderedRegistry.ts:319

takeFirst

takeFirst(): undefined | KeyValuePair<TKey, TValue>
Removes the first node and returns its value.

Returns undefined | KeyValuePair<TKey, TValue>
Inherited from OrderedRegistryBase.takeFirst
- Defined in OrderedRegistry.ts:253

takeLast

takeLast(): undefined | KeyValuePair<TKey, TValue>
Removes the last node and returns its value.

Returns undefined | KeyValuePair<TKey, TValue>
Inherited from OrderedRegistryBase.takeLast
- Defined in OrderedRegistry.ts:264

Generated using TypeDoc