fragment-cache

    0.2.1 • Public • Published

    fragment-cache NPM version NPM downloads Linux Build Status

    A cache for managing namespaced sub-caches

    Install

    Install with npm:

    $ npm install --save fragment-cache

    Usage

    var Fragment = require('fragment-cache');
    var fragment = new Fragment();

    API

    FragmentCache

    Create a new FragmentCache with an optional object to use for caches.

    Example

    var fragment = new FragmentCache();

    Params

    • cacheName {String}
    • returns {Object}: Returns the map-cache instance.

    .cache

    Get cache name from the fragment.caches object. Creates a new MapCache if it doesn't already exist.

    Example

    var cache = fragment.cache('files');
    console.log(fragment.caches.hasOwnProperty('files'));
    //=> true

    Params

    • cacheName {String}
    • returns {Object}: Returns the map-cache instance.

    .set

    Set a value for property key on cache name

    Example

    fragment.set('files', 'somefile.js', new File({path: 'somefile.js'}));

    Params

    • name {String}
    • key {String}: Property name to set
    • val {any}: The value of key
    • returns {Object}: The cache instance for chaining

    .has

    Returns true if a non-undefined value is set for key on fragment cache name.

    Example

    var cache = fragment.cache('files');
    cache.set('somefile.js');
     
    console.log(cache.has('somefile.js'));
    //=> true
     
    console.log(cache.has('some-other-file.js'));
    //=> false

    Params

    • name {String}: Cache name
    • key {String}: Optionally specify a property to check for on cache name
    • returns {Boolean}

    .get

    Get name, or if specified, the value of key. Invokes the cache method, so that cache name will be created it doesn't already exist. If key is not passed, the entire cache (name) is returned.

    Example

    var Vinyl = require('vinyl');
    var cache = fragment.cache('files');
    cache.set('somefile.js', new Vinyl({path: 'somefile.js'}));
    console.log(cache.get('somefile.js'));
    //=> <File "somefile.js">

    Params

    • name {String}
    • returns {Object}: Returns cache name, or the value of key if specified

    About

    Related projects

    • base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
    • map-cache: Basic cache object for storing key-value pairs. | homepage

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Building docs

    (This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

    To generate the readme and API documentation with verb:

    $ npm install -g verb verb-generate-readme && verb

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb-generate-readme, v0.2.0, on October 17, 2016.

    Install

    npm i fragment-cache

    DownloadsWeekly Downloads

    16,922,961

    Version

    0.2.1

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert