Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@jacobbubu/capped-event

jacobbubu9MIT1.2.1TypeScript support: included

Build Status Coverage Status

readme

@jacobbubu/capped-event

Build Status Coverage Status npm

A derived class from ReliableEvent in scuttlebutt-pull that provides basic cache management capabilities.

Intro.

The ReliableEvent in scuttlebutt-pull has not provided cache mechanism.

You can only push events into the instance of ReliableEvent, but there is no way to remove them.

In CappedEvent, we fire a notification when the items count for some event reached a warningLine that is setting by the options you passed through the construction.

For removing items from cache, we provide to methods:

  • pruneBefore(before: number, key: string): prune the items before xxx milliseconds.
  • pruneTo(remain: number, key: string): just keep remain items in cache.

Please the test case for the detail.