CacheJS

Class: Cache

Cache

Node.js in memory cache

new Cache(options)

Constructor
Parameters:
Name Type Argument Description
options Object <optional>
Properties
Name Type Argument Default Description
gci Number <optional>
 1000 GC interval in ms
limit Number <optional>
 1048576 Cache entries limit
ttl Number <optional>
 10 Entry TTL in sec
disableGC Boolean <optional>
 false Disables GC
Author:

Methods

clear()

Clears cache entries

destroy()

Stops gc and clears all data including timeouts

gc()

Garbage collecting

gcIsRunning()

Determinates whatever GC is running
Returns:
Type
Boolean

gcStart()

Starts garbage collecting

gcStop()

Stops garbage collecting

get(key)

Gets value of key if exists
Parameters:
Name Type Description
key String
Returns:
Type
*

has(key)

Parameters:
Name Type Description
key String
Returns:
Type
Boolean

keys()

Returns:
Type
Array

remove(key)

Deletes entry
Parameters:
Name Type Description
key String

set(key, value, ttl)

Sets
Parameters:
Name Type Description
key String
value *
ttl Number

trim()

Trims cache to setted limit

values()

Returns all cached values
Returns:
Type
Array