1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# fragment-cache [](https://www.npmjs.com/package/fragment-cache) [](https://npmjs.org/package/fragment-cache) [](https://travis-ci.org/jonschlinkert/fragment-cache)
> A cache for managing namespaced sub-caches
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save fragment-cache
```
## Usage
```js
var Fragment = require('fragment-cache');
var fragment = new Fragment();
```
## API
### [FragmentCache](index.js#L24)
Create a new `FragmentCache` with an optional object to use for `caches`.
**Example**
```js
var fragment = new FragmentCache();
```
**Params**
* `cacheName` **{String}**
* `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance.
### [.cache](index.js#L49)
Get cache `name` from the `fragment.caches` object. Creates a new `MapCache` if it doesn't already exist.
**Example**
```js
var cache = fragment.cache('files');
console.log(fragment.caches.hasOwnProperty('files'));
//=> true
```
**Params**
* `cacheName` **{String}**
* `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance.
### [.set](index.js#L67)
Set a value for property `key` on cache `name`
**Example**
```js
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](index.js#L93)
Returns true if a non-undefined value is set for `key` on fragment cache `name`.
**Example**
```js
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](index.js#L115)
Get `name`, or if specified, the value of `key`. Invokes the [cache](#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**
```js
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](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/node-base/base) | [homepage](https://github.com/node-base/base "base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.")
* [map-cache](https://www.npmjs.com/package/map-cache): Basic cache object for storing key-value pairs. | [homepage](https://github.com/jonschlinkert/map-cache "Basic cache object for storing key-value pairs.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install -g verb verb-generate-readme && verb
```
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
### License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/fragment-cache/blob/master/LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 17, 2016._
|
