workshopper-adventure-storage

workshopper-adventure-storage

Simple storage for workshopper-adventure

Originally included as part of workshopper-adventure, mostly written by Martin Heidegger

Based on prior work of: @substack @rvagg

Install

npm install workshopper-adventure-storage --save

const storage = require('workshopper-adventure-storage')

Properties

storage.dir

The path to store data in.

storage.userDir

A default path to store data in.

Methods

const storage = require('workshopper-adventure-storage')

storage([dir[, ...]])

Accepts a sequence of paths for path.resolve to use as the storage directory.

storage.save('name', data', cb)

JSON encodes and writes a file to the storage directory. The following will save the file as index.json.

const data = {
  foo: 'bar'
}
storage.save('index', data, (err) => {
  if (err) throw err
})

storage.get('name', cb)

Retrieves and unserializes a file from storage.

storage.get('index', (err, data) => {
  if (err) throw err
  console.log(file)
})

storage.reset(cb)

Clears the storage directory.

storage.reset((err) => {
  if (err) throw err
})