sfcode
An Online Competing and Development Environment
|
Basic object cache with
get
,set
,del
, andhas
methods for node.js/javascript projects.
Install with npm:
Inherit
Namespace
Define a custom property for storing values.
Create a Cache
constructor that when instantiated will store values on the given prop
.
Params
prop
**{String}**: The property name to use for storing values.returns
**{Function}**: Returns a custom Cache
constructorExample
Create a new Cache
. Internally the Cache
constructor is created using the namespace
function, with cache
defined as the storage object.
Params
cache
**{Object}**: Optionally pass an object to initialize with.Example
Assign value
to key
. Also emits set
with the key and value.
Params
key
**{String}**value
**{any}**returns
**{Object}**: Returns the instance for chaining.Events
emits
: set
with key
and value
as arguments.Example
Union array
to key
. Also emits set
with the key and value.
Params
key
**{String}**value
**{any}**returns
**{Object}**: Returns the instance for chaining.Example
Return the value of key
. Dot notation may be used to get nested property values.
Params
key
**{String}**: The name of the property to get. Dot-notation may be used.returns
**{any}**: Returns the value of key
Events
emits
: get
with key
and value
as arguments.Example
Return true if app has a stored value for key
, false only if value is undefined
.
Params
key
**{String}**returns
**{Boolean}**Events
emits
: has
with key
and true or false as arguments.Example
Delete one or more properties from the instance.
Params
key
**{String|Array}**: Property name or array of property names.returns
**{Object}**: Returns the instance for chaining.Events
emits
: del
with the key
as the only argument.Example
Reset the entire cache to an empty object.
Example
Visit method
over the properties in the given object, or map visit over the object-elements in an array.
Params
method
**{String}**: The name of the base
method to call.val
**{Object|Array}**: The object or array to iterate over.returns
**{Object}**: Returns the instance for chaining.a.b.c
) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value "Use property paths (`a.b.c`) to get a nested value from an object.")) paths. | [homepage](https://github.com/jonschlinkert/set-value "Create nested values and any intermediaries using dot notation (</tt>'a.b.c'`) paths.")
[unset-value](https://www.npmjs.com/package/unset-value): Delete nested properties from an object using dot notation. | [homepage](https://github.com/jonschlinkert/unset-value "Delete nested properties from an object using dot notation.")
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Commits | Contributor |
---|---|
54 | jonschlinkert |
2 | wtgtybhertgeghgtwtg |
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the [MIT License](LICENSE).
This file was generated by verb-generate-readme, v0.6.0, on July 22, 2017.