https://github.com/workshopper/workshopper-adventure-storage
Storing workshopper progress
https://github.com/workshopper/workshopper-adventure-storage
nodeschool util workshopper
Last synced: about 1 month ago
JSON representation
Storing workshopper progress
- Host: GitHub
- URL: https://github.com/workshopper/workshopper-adventure-storage
- Owner: workshopper
- License: other
- Created: 2016-09-19T05:59:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-06T03:35:42.000Z (about 5 years ago)
- Last Synced: 2025-04-16T04:20:23.770Z (about 2 months ago)
- Topics: nodeschool, util, workshopper
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# workshopper-adventure-storage
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]
[![NPM deps][deps-image]][deps-url] [![NPM dev devp][dev-deps-image]][dev-deps-url]
Simple storage for [workshopper-adventure](https://github.com/workshopper/workshopper-adventure)
Originally included as part of workshopper-adventure, mostly written by [Martin Heidegger](https://github.com/martinheidegger)
Based on prior work of:
[@substack](https://github.com/substack)
[@rvagg](https://github.com/rvagg)
## Install
```
npm install workshopper-adventure-storage --save
```
```js
const createStorage = require('workshopper-adventure-storage')
```
## Usage
### createStorage.userDir
A default path to store data in.
### createStorage([dir[, ...]])
Accepts a sequence of paths for `path.resolve` to use as the storage directory.
```js
const createStorage = require('workshopper-adventure-storage')
const storage = createStorage(createStorage.userDir, 'my-workshopper')
```
## Properties
### storage.dir
The path to store data in.
## Methods
### storage.save('name', data)
JSON encodes and writes a file to the storage directory. The following will
save the file as `index.json`.
```js
const data = {
foo: 'bar'
}
storage.save('index', data)
```
## storage.get('name')
Retrieves and unserializes a file from storage.
```js
var data = storage.get('index')
```
## storage.reset()
Clears the storage directory.
```js
storage.reset()
```
## storage.promises
This module seamlessly supports async operations using the `.promises` object.
```js
const storage =
createStorage(createStorage.userDir, 'promise-workshop')
.promises;
storage.dir // works synchronously
await storage.save('name', {})
await storage.get('name')
await storage.reset()
```
[downloads-image]: http://img.shields.io/npm/dm/workshopper-adventure-storage.svg
[npm-url]: https://npmjs.org/package/workshopper-adventure-storage
[npm-image]: http://img.shields.io/npm/v/workshopper-adventure-storage.svg
[deps-url]:https://david-dm.org/workshopper/workshopper-adventure-storage
[deps-image]: https://img.shields.io/david/workshopper/workshopper-adventure-storage.svg
[dev-deps-url]: https://david-dm.org/workshopper/workshopper-adventure-storage?type=dev
[dev-deps-image]: https://img.shields.io/david/dev/workshopper/workshopper-adventure-storage.svg
[travis-url]: https://travis-ci.org/workshopper/workshopper-adventure-storage
[travis-image]: https://travis-ci.org/workshopper/workshopper-adventure-storage.png?branch=master
[coveralls-url]: https://coveralls.io/github/workshopper/workshopper-adventure-storage?branch=master
[coveralls-image]: https://coveralls.io/repos/github/workshopper/workshopper-adventure-storage/badge.svg?branch=master