Neverending Pile of Messages
    Have ideas to improve npm?Join in the discussion! »

    memoizee-proxy
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.9 • Public • Published

    memoizee-proxy

    Build Status NPM Version

    Read this in other languages: 简体中文

    Memoize based on Proxy.

    features

    • [x] Works with any type, any length of function arguments - optional serialization.
    • [x] Support for promises and asynchronous functions.
    • [x] Configurable weak provides a WeakMap (friendly garbage collection).
    • [x] Cache can be managed manually.
    • [x] Cache size can be limited on LRU basis.
    • [x] Optional reference counter mode, that allows more sophisticated cache management.
    • [x] unit tests.

    API

    Property Description Type Default
    normalizer Generates a unique value based on the current parameter (args: any[]) => string Array.from(argument).join(',')
    weak Using WeakMap boolean false
    maxAge Timeout duration, expired delete number undefined
    max Maximum number of items stored number undefined
    manual Enable manage the cache manually boolean false
    refCounter Enable reference counting boolean false
    dispose Called right before an item is evicted from the cache (value: T) => void undefined
    closeable Provide use cache toggle function boolean false

    Installation

    npm install memoizee-proxy

    or

    yarn add memoizee-proxy

    Usage

    import {memoizee} from 'memoizee-proxy'
    
    var fn = function(one, two, three) {
      /* ... */
    };
    
    var memoized = memoizee(fn);
    
    memoized("foo", 3, "bar");
    memoized("foo", 3, "bar"); // Cache hit
    var afn = function(a, b) {
    	return new Promise(function(res) {
    		res(a + b);
    	});
    };
    memoized = memoize(afn, { promise: true });
    
    memoized(3, 7);
    memoized(3, 7); // Cache hit

    Changelog

    0.1.9

    • The build tool was changed from microbundle to tsdx

    0.1.6

    • Add the closeable parameter to operate on and off the cache

    0.1.3

    • Modify the packaging tool to Rome (modify the default export)
    • Export the other two cache classes ExpiredLRUCache RefCache

    0.0.4

    • fix cacheRef clear method missing cacheRef cleanup.
    • remove "max" and "maxAge" options cannot exist at the same time.

    0.0.3

    • fix the options "max". if the added value is greater than or equal to max, throw error.

    0.0.2

    • Basically completed, added max, maxAge to provide data management.
    • Manual is added to control the cache manually.
    • Reference count cache added.
    • Add the dispose function to call the control value when deleting data.
    • Add unit tests.

    0.0.1

    • Basically available, add parameters "normalizer"、 "weak" 、"timeout"

    Install

    npm i memoizee-proxy

    DownloadsWeekly Downloads

    44

    Version

    0.1.9

    License

    MIT

    Unpacked Size

    182 kB

    Total Files

    43

    Last publish

    Collaborators

    • avatar