SyncCacheAdapter

Hierarchy

• CacheAdapter
  • SyncCacheAdapter

Implemented by

• FileCacheAdapter
• NullCacheAdapter

Index

Methods

• clear
• close
• combine
• get
• remove
• set

Methods

inheritedclear

• clear(): void | Promise<void>

• Inherited from CacheAdapter.clear

  Clears all items stored in the cache.

  ---

  Returns void | Promise<void>

optionalinheritedclose

• close(): void | Promise<void>

• Inherited from CacheAdapter.close

  Called inside MikroORM.close() Allows graceful shutdowns (e.g. for redis).

  ---

  Returns void | Promise<void>

optionalcombine

• combine(): string | void

• Generates a combined cache from all existing entries.

  ---

  Returns string | void

get

• get(name: string): undefined | T

• Overrides CacheAdapter.get

  Gets the items under name key from the cache.

  ---

  Parameters

  • name: string

  Returns undefined | T

remove

• remove(name: string): void

• Overrides CacheAdapter.remove

  Removes the item from cache.

  ---

  Parameters

  • name: string

  Returns void

set

• set(name: string, data: any, origin: string, expiration?: number): void

• Overrides CacheAdapter.set

  Sets the item to the cache. origin is used for cache invalidation and should reflect the change in data.

  ---

  Parameters

  • name: string

  • data: any

  • origin: string

  • optionalexpiration: number

  Returns void