Skip to content

Commit 517efb5

Browse files
committed
generate docs
1 parent 9fe9065 commit 517efb5

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

.verb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ console.log(app.data);
5151

5252
## API
5353

54-
{%= apidocs("index.js") %}
54+
{%= apidocs("index.js") %}

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cache-base [![NPM version](https://img.shields.io/npm/v/cache-base.svg)](https://www.npmjs.com/package/cache-base) [![Build Status](https://img.shields.io/travis/jonschlinkert/cache-base.svg)](https://travis-ci.org/jonschlinkert/cache-base)
1+
# cache-base [![NPM version](https://img.shields.io/npm/v/cache-base.svg?style=flat)](https://www.npmjs.com/package/cache-base) [![NPM downloads](https://img.shields.io/npm/dm/cache-base.svg?style=flat)](https://npmjs.org/package/cache-base) [![Build Status](https://img.shields.io/travis/jonschlinkert/cache-base.svg?style=flat)](https://travis-ci.org/jonschlinkert/cache-base)
22

33
> Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.
44
@@ -126,7 +126,26 @@ console.log(app);
126126
//=> {name: 'Halle', foo: 'bar', baz: 'quux'}
127127
```
128128

129-
### [.get](index.js#L109)
129+
### [.union](index.js#L106)
130+
131+
Union `array` to `key`. Also emits `set` with the key and value.
132+
133+
**Params**
134+
135+
* `key` **{String}**
136+
* `value` **{any}**
137+
* `returns` **{Object}**: Returns the instance for chaining.
138+
139+
**Example**
140+
141+
```js
142+
app.union('a.b', ['foo']);
143+
app.union('a.b', ['bar']);
144+
console.log(app.get('a'));
145+
//=> {b: ['foo', 'bar']}
146+
```
147+
148+
### [.get](index.js#L132)
130149

131150
Return the value of `key`. Dot notation may be used to get [nested property values][get-value].
132151

@@ -150,7 +169,7 @@ app.get(['a', 'b']);
150169
//=> {c: 'd'}
151170
```
152171

153-
### [.has](index.js#L136)
172+
### [.has](index.js#L159)
154173

155174
Return true if app has a stored value for `key`, false only if value is `undefined`.
156175

@@ -171,7 +190,7 @@ app.has('foo');
171190
//=> true
172191
```
173192

174-
### [.del](index.js#L164)
193+
### [.del](index.js#L187)
175194

176195
Delete one or more properties from the instance.
177196

@@ -194,7 +213,7 @@ app.del('foo');
194213
app.del(['foo', 'bar']);
195214
```
196215

197-
### [.clear](index.js#L183)
216+
### [.clear](index.js#L206)
198217

199218
Reset the entire cache to an empty object.
200219

@@ -204,7 +223,7 @@ Reset the entire cache to an empty object.
204223
app.clear();
205224
```
206225

207-
### [.visit](index.js#L200)
226+
### [.visit](index.js#L223)
208227

209228
Visit `method` over the properties in the given object, or map
210229
visit over the object-elements in an array.
@@ -217,8 +236,10 @@ visit over the object-elements in an array.
217236

218237
## Related projects
219238

239+
You might also be interested in these projects:
240+
220241
* [base-methods](https://www.npmjs.com/package/base-methods): base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://www.npmjs.com/package/base-methods) | [homepage](https://github.com/jonschlinkert/base-methods)
221-
* [get-value](https://www.npmjs.com/package/get-value): Use property paths (` a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)
242+
* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)
222243
* [has-value](https://www.npmjs.com/package/has-value): Returns true if a value exists, false if empty. Works with deeply nested values using… [more](https://www.npmjs.com/package/has-value) | [homepage](https://github.com/jonschlinkert/has-value)
223244
* [option-cache](https://www.npmjs.com/package/option-cache): Simple API for managing options in JavaScript applications. | [homepage](https://github.com/jonschlinkert/option-cache)
224245
* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value)
@@ -259,9 +280,9 @@ $ npm install -d && npm test
259280

260281
## License
261282

262-
Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
283+
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
263284
Released under the [MIT license](https://github.com/jonschlinkert/cache-base/blob/master/LICENSE).
264285

265286
***
266287

267-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on March 02, 2016._
288+
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 21, 2016._

0 commit comments

Comments
 (0)