Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolicyBasedCache<Key, Value, ArgumentsBundle>

Cache implementation which uses CacheReplacementPolicy for keys eviction.
Although any predefined policy can be used, there are some restrictions for multiple policies combination.
You can combine only 1 policy from each category:

Type parameters

  • Key

    Type of the key.

  • Value

    Type of the value.

  • ArgumentsBundle

    Type of the arguments bundle.

Hierarchy

  • EventEmitter
    • PolicyBasedCache

Implements

  • Cache<Key, Value, ArgumentsBundle>

Constructors

constructor

  • Type parameters

    • Key

    • Value

    • ArgumentsBundle

    Parameters

    • backend: CacheBackend<Key, Value>

      Cache backend.

    • Optional policies: CacheReplacementPolicy<Key, Value, ArgumentsBundle>[]

      Array of policies.
      If you pass nothing or an empty array, cache will act as a simple wrapper over backend.

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

size

  • get size(): number
  • Get number of cache entries.

    Returns number

Methods

addListener

  • addListener(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Alias for emitter.on(eventName, listener).

    since

    v0.1.26

    Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

clear

  • clear(): void
  • Clear all cache entries.
    After successful clear, CacheEvent.FLUSH event will be emitted.

    Returns void

del

  • del(key: Key): boolean
  • Delete key and it's associated value.
    After successful deletion, CacheEvent.DELETE event will be emitted.

    Parameters

    • key: Key

      Name of the key.

    Returns boolean

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();
    
    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });
    
    console.log(myEmitter.listeners('event'));
    
    myEmitter.emit('event', 1, 2, 3, 4, 5);
    
    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
    
    since

    v0.1.26

    Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});
    
    const sym = Symbol('symbol');
    myEE.on(sym, () => {});
    
    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    
    since

    v6.0.0

    Returns (string | symbol)[]

get

  • get(key: Key): Undefinable<Value>
  • Get the value associated with key.

    Parameters

    • key: Key

      Name of the key.

    Returns Undefinable<Value>

getMaxListeners

  • getMaxListeners(): number
  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    since

    v1.0.0

    Returns number

has

  • has(key: Key): boolean
  • Check whether key is present in the cache, without calling policies onHit hook.
    Notice, that some policies might evict item when onHit hook is called (e.g. item expired), therefore even if method returns true, trying to get item might evict him and you will get undefined as result.

    Parameters

    • key: Key

      Name of the key.

    Returns boolean

keys

  • keys(): Key[]
  • Get all cache keys.

    Returns Key[]

listenerCount

  • listenerCount(event: string | symbol): number
  • Returns the number of listeners listening to the event named eventName.

    since

    v3.2.0

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
    
    since

    v0.1.26

    Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Alias for emitter.removeListener().

    since

    v10.0.0

    Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

on

once

  • once(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
    
    since

    v0.3.0

    Parameters

    • event: string | symbol
    • listener: function

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

prependListener

  • prependListener(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
    

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v6.0.0

    Parameters

    • event: string | symbol
    • listener: function

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v6.0.0

    Parameters

    • event: string | symbol
    • listener: function

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));
    
    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];
    
    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();
    
    // Logs "log once" to the console and removes the listener
    logFnWrapper();
    
    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');
    
    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
    
    since

    v9.4.0

    Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.1.26

    Parameters

    • Optional event: string | symbol

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

removeListener

  • removeListener(event: string | symbol, listener: function): PolicyBasedCache<Key, Value, ArgumentsBundle>
  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
    

    removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

    Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    const myEmitter = new MyEmitter();
    
    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };
    
    const callbackB = () => {
      console.log('B');
    };
    
    myEmitter.on('event', callbackA);
    
    myEmitter.on('event', callbackB);
    
    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B
    
    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
    

    Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

    When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

    const ee = new EventEmitter();
    
    function pong() {
      console.log('pong');
    }
    
    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);
    
    ee.emit('ping');
    ee.emit('ping');
    

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.1.26

    Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

set

  • set(key: Key, value: Value, argsBundle?: ArgumentsBundle): void
  • Set value associated with key.
    After successful insertion/update, according CacheEvent.INSERT, respectively CacheEvent.UPDATE events will be emitted.

    Parameters

    • key: Key

      Name of the key.

    • value: Value

      It's associated value.

    • Optional argsBundle: ArgumentsBundle

      Bundle of arguments passed by client for this operation.

    Returns void

setMaxListeners

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.3.5

    Parameters

    • n: number

    Returns PolicyBasedCache<Key, Value, ArgumentsBundle>

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>