Storage(name, fs, configPath)

Storage instances handle a json file where Generator authors can store data.

The Generator class instantiate the storage named config by default.

new Storage(name, fs, configPath)
util/storage.js, line 22

Parameters:
Name Type Description
name String

The name of the new storage (this is a namespace)
fs mem-fs-editor

A mem-fs editor instance
configPath String

The filepath used as a storage.
Example
class extend Generator {
  writing: function() {
    this.config.set('coffeescript', false);
  }
}

Methods

defaults(defaults) → {*}
util/storage.js, line 114

Setup the store with defaults value and schedule a save. If keys already exist, the initial value is kept.

Parameters:
Name Type Description
defaults Object

Key-value object to store.
Returns:
* -

val Returns the merged options.

delete(key)
util/storage.js, line 102

Delete a key from the store and schedule a save.

Parameters:
Name Type Description
key String

The key under which the value is stored.

get(key) → {*}
util/storage.js, line 65

Get a stored value

Parameters:
Name Type Description
key String

The key under which the value is stored.
Returns:
* -

The stored value. Any JSON valid type could be returned

getAll() → {Object}
util/storage.js, line 73

Get all the stored values

Returns:
Object -

key-value object

save()
util/storage.js, line 56

Save a new object of values

set(key, val) → {*}
util/storage.js, line 83

Assign a key to a value and schedule a save.

Parameters:
Name Type Description
key String

The key under which the value is stored
val *

Any valid JSON type value (String, Number, Array, Object).
Returns:
* -

val Whatever was passed in as val.