fragment-cache
A cache for managing namespaced sub-caches
Install
Install with npm:
Usage
API
Create a new FragmentCache
with an optional object to use for caches
.
Example
Params
cacheName
{String}returns
{Object}: Returns the map-cache instance.
Get cache name
from the fragment.caches
object. Creates a new MapCache
if it doesn't already exist.
Example
Params
cacheName
{String}returns
{Object}: Returns the map-cache instance.
Set a value for property key
on cache name
Example
Params
name
{String}key
{String}: Property name to setval
{any}: The value ofkey
returns
{Object}: The cache instance for chaining
Returns true if a non-undefined value is set for key
on fragment cache name
.
Example
Params
name
{String}: Cache namekey
{String}: Optionally specify a property to check for on cachename
returns
{Boolean}
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
Params
name
{String}returns
{Object}: Returns cachename
, or the value ofkey
if specified
About
Related projects
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:
Running tests
Install dev dependencies:
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.
Last updated