Class TileCache

constructor

• new TileCache(max: number, onRemove: (element: Tile) => void): TileCache

  Parameters

  • max: number

    number of permitted values

  • onRemove: (element: Tile) => void

    callback called with items when they expire

  Returns TileCache

data

max

onRemove

order

add

• add(tileID: OverscaledTileID, data: Tile, expiryTimeout: number | void): this

  Add a key, value combination to the cache, trimming its size if this pushes it over max length.

  Parameters

  • tileID: OverscaledTileID

    lookup key for the item

  • data: Tile

    tile data

  • expiryTimeout: number | void

  Returns this

  this cache

filter

• filter(filterFn: (tile: Tile) => boolean): void

  Remove entries that do not pass a filter function. Used for removing stale tiles from the cache.

  Parameters

  • filterFn: (tile: Tile) => boolean

    Determines whether the tile is filtered. If the supplied function returns false, the tile will be filtered out.

  Returns void

get

• get(tileID: OverscaledTileID): Tile

  Get the value attached to a specific key without removing data from the cache. If the key is not found, returns null

  Parameters

  • tileID: OverscaledTileID

    the key to look up

  Returns Tile

  the tile data, or null if it isn't found

getAndRemove

• getAndRemove(tileID: OverscaledTileID): Tile

  Get the value attached to a specific key and remove data from cache. If the key is not found, returns null

  Parameters

  • tileID: OverscaledTileID

    the key to look up

  Returns Tile

  the tile data, or null if it isn't found

getByKey

• getByKey(key: string): Tile

  Parameters

  • key: string

  Returns Tile

has

• has(tileID: OverscaledTileID): boolean

  Determine whether the value attached to key is present

  Parameters

  • tileID: OverscaledTileID

    the key to be looked-up

  Returns boolean

  whether the cache has this value

remove

• remove(
      tileID: OverscaledTileID,
      value?: { timeout: Timeout; value: Tile },
  ): this

  Remove a key/value combination from the cache.

  Parameters

  • tileID: OverscaledTileID

    the key for the pair to delete

  • Optionalvalue: { timeout: Timeout; value: Tile }

    If a value is provided, remove that exact version of the value.

  Returns this

  this cache

reset

• reset(): this

  Clear the cache

  Returns this

  this cache

setMaxSize

• setMaxSize(max: number): this

  Change the max size of the cache.

  Parameters

  • max: number

    the max size of the cache

  Returns this

  this cache