Skip to main content
Version: 5.3

CacheAdapter

Implemented by

Index

Methods

clear

  • clear(): Promise<void>
  • Clears all items stored in the cache.


    Returns Promise<void>

optionalclose

  • close(): Promise<void>
  • Called inside MikroORM.close() Allows graceful shutdowns (e.g. for redis).


    Returns Promise<void>

get

  • get(name: string): Promise<any>
  • Gets the items under name key from the cache.


    Parameters

    • name: string

    Returns Promise<any>

remove

  • remove(name: string): Promise<void>
  • Removes the item from cache.


    Parameters

    • name: string

    Returns Promise<void>

set

  • set(name: string, data: any, origin: string, expiration?: number): Promise<void>
  • 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 Promise<void>