IdentityMap

Index

Constructors

• constructor

Methods

• [iterator]
• clear
• delete
• get
• getByHash
• getKeyHash
• getStore
• keys
• store
• storeByKey
• values

Constructors

constructor

• new IdentityMap(defaultSchema): IdentityMap

• Parameters

  • optionaldefaultSchema: string

  Returns IdentityMap

Methods

[iterator]

• [iterator](): IterableIterator<Partial<any>, any, any>

• Returns IterableIterator<Partial<any>, any, any>

clear

• clear(): void

• Returns void

delete

• delete<T>(item): void

• Parameters

  • item: T

  Returns void

get

• get<T>(hash): undefined | T

• For back compatibility only.

  ---

  Parameters

  • hash: string

  Returns undefined | T

getByHash

• getByHash<T>(meta, hash): undefined | T

• Parameters

  • meta: EntityMetadata<T, EntityCtor<T>>

  • hash: string

  Returns undefined | T

getKeyHash

• getKeyHash(key, value, schema): string

• Creates a hash for an alternate key lookup. Format: [key]value or schema:[key]value

  ---

  Parameters

  • key: string

  • value: string

  • optionalschema: string

  Returns string

getStore

• getStore<T>(meta): Map<string, T>

• Parameters

  • meta: EntityMetadata<T, EntityCtor<T>>

  Returns Map<string, T>

keys

• keys(): string[]

• Returns string[]

store

• store<T>(item): void

• Parameters

  • item: T

  Returns void

storeByKey

• storeByKey<T>(item, key, value, schema): void

• Stores an entity under an alternate key (non-PK property). This allows looking up entities by unique properties that are not the primary key.

  ---

  Parameters

  • item: T

  • key: string

  • value: string

  • optionalschema: string

  Returns void

values

• values(): Partial<any>[]

• Returns Partial<any>[]