Class EntityMap<K, V, T>

Heavily influenced by @ngrx/entity's entity adapter interface. The methods defined here are intended to follow the same paradigm as the ngrx adapter collection methods: https://ngrx.io/guide/entity/adapter#adapter-collection-methods

Type parameters

K
V
T: Map<K, V>

Hierarchy

EntityMap
- RxEntityMap

Implements

EntityMapLike<K, V>

Index

Constructors

constructor

Properties

Accessors

count

Constructors

constructor

new EntityMap<K, V, T>(store: T, selectKey: PropertySelector<K, V>): EntityMap<K, V, T>

- Defined in maps/entity-map.ts:46
Type parameters
- K
- V
- T: Map<K, V, T>
Parameters
- store: T
- selectKey: PropertySelector<K, V>
Returns EntityMap<K, V, T>

Properties

Protected Readonly selectKey

selectKey: PropertySelector<K, V>

Protected Readonly store

store: T

Accessors

count

get count(): number

- Defined in maps/entity-map.ts:64
Returns number

Methods

addMany

addMany(entities: V[]): V[]

Implementation of EntityMapLike.addMany
- Defined in maps/entity-map.ts:128
Parameters
- entities: V[]
Returns V[]

addOne

addOne(entity: V): undefined | V

Implementation of EntityMapLike.addOne
- Defined in maps/entity-map.ts:124
Parameters
- entity: V
Returns undefined | V

entries

entries(): [K, V][]

Implementation of EntityMapLike.entries
- Defined in maps/entity-map.ts:96
Returns [K, V][]

getMany

getMany(keys: K[]): V[]

Implementation of EntityMapLike.getMany
- Defined in maps/entity-map.ts:104
Parameters
- keys: K[]
Returns V[]

getManyExisting

getManyExisting(keys: K[]): V[]

Implementation of EntityMapLike.getManyExisting
- Defined in maps/entity-map.ts:108
Parameters
- keys: K[]
Returns V[]

getOne

getOne(key: K): undefined | V

Implementation of EntityMapLike.getOne
- Defined in maps/entity-map.ts:100
Parameters
- key: K
Returns undefined | V

hasEvery

hasEvery(keys: K[]): boolean

Implementation of EntityMapLike.hasEvery
- Defined in maps/entity-map.ts:116
Parameters
- keys: K[]
Returns boolean

hasOne

hasOne(key: K): boolean

Implementation of EntityMapLike.hasOne
- Defined in maps/entity-map.ts:112
Parameters
- key: K
Returns boolean

hasSome

hasSome(keys: K[]): boolean

Implementation of EntityMapLike.hasSome
- Defined in maps/entity-map.ts:120
Parameters
- keys: K[]
Returns boolean

isValidKey

isValidKey(key: undefined | null | K): boolean

- Defined in maps/entity-map.ts:72
Parameters
- key: undefined | null | K
Returns boolean

iterableEntries

iterableEntries(): IterableIterator<[K, V]>

- Defined in maps/entity-map.ts:92
Returns IterableIterator<[K, V]>

iterableKeys

iterableKeys(): IterableIterator<K>

- Defined in maps/entity-map.ts:76
Returns IterableIterator<K>

iterableValues

iterableValues(): IterableIterator<V>

- Defined in maps/entity-map.ts:84
Returns IterableIterator<V>

keyOf

keyOf(entity: V): undefined | K

Implementation of EntityMapLike.keyOf
- Defined in maps/entity-map.ts:68
Parameters
- entity: V
Returns undefined | K

keys

keys(): K[]

Implementation of EntityMapLike.keys
- Defined in maps/entity-map.ts:80
Returns K[]

Protected onDeleteEntry

onDeleteEntry(key: K): boolean

- Defined in maps/entity-map.ts:56
Parameters
- key: K
Returns boolean

Protected onMergeEntries

onMergeEntries(a?: Partial<V>, b?: Partial<V>): V

- Defined in maps/entity-map.ts:60
Parameters
- Optional a: Partial<V>
- Optional b: Partial<V>
Returns V

Protected onSetEntry

onSetEntry(key: K, value: V): void

- Defined in maps/entity-map.ts:52
Parameters
- key: K
- value: V
Returns void

removeAll

removeAll(): void

Implementation of EntityMapLike.removeAll
- Defined in maps/entity-map.ts:179
Returns void

removeMany

removeMany(keys: K[]): boolean[]

Implementation of EntityMapLike.removeMany
- Defined in maps/entity-map.ts:156
Parameters
- keys: K[]
Returns boolean[]

removeOne

removeOne(key: K): boolean

Implementation of EntityMapLike.removeOne
- Defined in maps/entity-map.ts:152
Parameters
- key: K
Returns boolean

removeWhere

removeWhere(predicate: Predicate<V>): V[]

Implementation of EntityMapLike.removeWhere
- Defined in maps/entity-map.ts:160
Parameters
- predicate: Predicate<V>
Returns V[]

setAll

setAll(entities: V[]): V[]

Implementation of EntityMapLike.setAll
- Defined in maps/entity-map.ts:147
Parameters
- entities: V[]
Returns V[]

setMany

setMany(entities: V[]): V[]

Implementation of EntityMapLike.setMany
- Defined in maps/entity-map.ts:143
Parameters
- entities: V[]
Returns V[]

setOne

setOne(entity: V): V

Implementation of EntityMapLike.setOne
- Defined in maps/entity-map.ts:132
Parameters
- entity: V
Returns V

transformMany

transformMany(transform: EntityTransform<V>): V[]

Implementation of EntityMapLike.transformMany
- Defined in maps/entity-map.ts:231
Parameters
- transform: EntityTransform<V>
Returns V[]

transformOne

transformOne(key: K, transform: EntityTransform<V>): undefined | V

Implementation of EntityMapLike.transformOne
- Defined in maps/entity-map.ts:219
Parameters
- key: K
- transform: EntityTransform<V>
Returns undefined | V

updateMany

updateMany(updates: Update<K, V>[]): V[]

Implementation of EntityMapLike.updateMany
- Defined in maps/entity-map.ts:199
Parameters
- updates: Update<K, V>[]
Returns V[]

updateOne

updateOne(update: Update<K, V>): undefined | V

Implementation of EntityMapLike.updateOne
- Defined in maps/entity-map.ts:189
Parameters
- update: Update<K, V>
Returns undefined | V

updateOneByKey

updateOneByKey(key: K, changes: Partial<V>): undefined | V

Implementation of EntityMapLike.updateOneByKey
- Defined in maps/entity-map.ts:183
Parameters
- key: K
- changes: Partial<V>
Returns undefined | V

upsertMany

upsertMany(entities: V[]): V[]

Implementation of EntityMapLike.upsertMany
- Defined in maps/entity-map.ts:215
Parameters
- entities: V[]
Returns V[]

upsertOne

upsertOne(entity: V): undefined | V

Implementation of EntityMapLike.upsertOne
- Defined in maps/entity-map.ts:203
Parameters
- entity: V
Returns undefined | V

values

values(): V[]

Implementation of EntityMapLike.values
- Defined in maps/entity-map.ts:88
Returns V[]

Generated using TypeDoc