Class UniqueHashIndex<In, Out>

Indexes items using a JavaScript Map, and ensures uniqueness.

Throws a ConflictException if a duplicate item is added.

Type Parameters

In extends number | string
Out

Hierarchy

Index<In, Out>
- UniqueHashIndex

Index

Constructors

Properties

Methods

_onUpdate add countDistinct delete eq item update create

Constructors

`Private` constructor

new UniqueHashIndex<In, Out>(ctx): UniqueHashIndex<In, Out>
Type Parameters
- In extends string | number
- Out
Parameters
- ctx: IndexContext<Out>
Returns UniqueHashIndex<In, Out>
Overrides Index.constructor
- Defined in core/src/indexes/UniqueHashIndex.ts:22

Properties

`Private` `Readonly` ix

ix: Map<In, Id> = ...

Methods

_onUpdate

_onUpdate(update): (() => void)
Parameters
- update: Update<In>
Returns (() => void)
- - (): void
  - Returns void
Overrides Index._onUpdate
- Defined in core/src/indexes/UniqueHashIndex.ts:34

`Private` add

add(id, value): void
Parameters
- id: Id
- value: In
Returns void
- Defined in core/src/indexes/UniqueHashIndex.ts:57

countDistinct

countDistinct(): number
Returns number
- Defined in core/src/indexes/UniqueHashIndex.ts:71

`Private` delete

delete(id, oldValue): void
Parameters
- id: Id
- oldValue: In
Returns void
- Defined in core/src/indexes/UniqueHashIndex.ts:66

eq

eq(value): undefined | Item<Out>
Parameters
- value: In
Returns undefined | Item<Out>
- Defined in core/src/indexes/UniqueHashIndex.ts:75

`Protected` item

item(id): Item<Out>
Parameters
- id: Id
Returns Item<Out>
Inherited from Index.item
- Defined in core/src/core/Index.ts:16

`Private` update

update(id, oldValue, newValue): void
Parameters
- id: Id
- oldValue: In
- newValue: In
Returns void
- Defined in core/src/indexes/UniqueHashIndex.ts:61

`Static` create

create<T, O>(): UnregisteredIndex<T, O, UniqueHashIndex<T, O>>
Type Parameters
- T extends string | number
- O
Returns UnregisteredIndex<T, O, UniqueHashIndex<T, O>>
- Defined in core/src/indexes/UniqueHashIndex.ts:26

Generated using TypeDoc