base-stash

base-stash

Base application plugin that adds methods to applications for stashing and restoring object states.

You might also be interested in stash-object.

Install

Install with npm:

$ npm install --save base-stash

Usage

var stash = require('base-stash');
app.use(stash());

API

.stash

Stash an object property from the app with an optional "name".

Params

• prop {String}: Property to stash (e.g. options or cache);
• name {String}: Name to use to "tag" the stash to restore from later.

Example

app.stash('options');

.restore

Restore a previously stashed object. Optionally restore from a specific "name" that was used with .stash. When a "name" is not specified, the last stashed object is used.

Params

• prop {String}: Property to restore (e.g. options or cache);
• name {String}: Name used when stashing to restore directly to that spot.

Example

app.restore('options');

About

Related projects

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
• stash-object: Stash the current state of an object and restore at a later time. | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
• update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | 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

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

This file was generated by verb, v0.9.0, on July 28, 2016.