Registry / storage / workshopper-adventure-storage

workshopper-adventure-storage

library3.0.1jsnpmunverified

A simple JSON file-based storage module for workshopper-adventure, used to persist user preferences and progress. Version 3.0.1 is the latest release, with low release cadence (last updated in 2016). It provides save, get, and reset methods for managing a directory of JSON files. Differentiator: lightweight and focused on the workshopper ecosystem, avoiding the complexity of full database solutions.

storage

npm install workshopper-adventure-storage

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · WORKSHOPPER-ADVENT

workshopper-adventure-storage

storagejavascriptv3.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createStorage

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

✗ import createStorage from 'workshopper-adventure-storage'

This package does not support ES modules; use CommonJS require.

createStorage.userDir

✓ createStorage.userDir

A default directory path for user data.

storage.save

✓ storage.save('name', data)

Saves JSON-encoded data to a file named 'name.json'.

Initializes storage in a user-specific directory, saves progress JSON, retrieves it, and resets the storage.

const createStorage = require('workshopper-adventure-storage'); const storage = createStorage(createStorage.userDir, 'my-workshopper'); storage.save('progress', { completed: ['lesson1'] }); const data = storage.get('progress'); console.log(data); // { completed: ['lesson1'] } storage.reset(); // clears the storage directory

Debug

Known issues

gotchastorage.save always overwrites existing file without warning.

fix

Check file existence manually before saving if needed.

affects: >=1.0.0

gotchastorage.get returns null if file does not exist; no error handling.

fix

Always check for null after calling storage.get.

affects: >=1.0.0

gotchastorage.reset is synchronous and can block the event loop for large directories.

fix

Use in small directories; consider using async alternatives for large data.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: createStorage is not a function

Using ES import syntax or incorrect require path.

fix

Use const createStorage = require('workshopper-adventure-storage') and ensure package is installed.

Error: ENOENT: no such file or directory, open '...'

Storage directory does not exist; createStorage does not create intermediate directories.

fix

Ensure parent directories exist before calling createStorage.

Upgrade

Version history

3.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

29 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/workshopper/workshopper-adventure-storage ↗

packageworkshopper-adventure-storage ↗

homepagehttps://github.com/workshopper/workshopper-adventure-storage#readme ↗