hidden-gem-storage v1.0.5

hidden-gem-storage

hidden-gem-storage is a simple, lightweight JavaScript library for abstracted storage operations, seamlessly supporting both browser local storage and Node.js local storage via localforage and node-localstorage. This makes it an ideal choice for projects that need to run both in the browser and in a Node.js environment without changing storage access patterns.

Installation

To install hidden-gem-storage, run the following command in your project directory:

npm install hidden-gem-storage

Usage

First, require hidden-gem-storage in your project:

const storage = require('hidden-gem-storage');

Setting an item

To store data, use the setItem function:

storage.setItem('yourKey', 'yourValue');

This function saves a value under a specified key. In a browser environment, it uses localStorage; in Node.js, it uses localforage.

Retrieving an item

To retrieve stored data, use the getItem function:

storage.getItem('yourKey').then((value) => {
console.log(value); // Outputs: 'yourValue'
});

This function retrieves the value associated with the given key. As with setItem, it abstracts away the environment-specific storage mechanism.

API Reference

• setItem(key, value): Stores a value under the specified key. Automatically selects the appropriate storage mechanism based on the environment.
• getItem(key): Retrieves the value associated with the specified key. Returns a Promise that resolves with the value.

Contributing

Contributions are welcome! If you'd like to contribute to hidden-gem-storage, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes with clear, descriptive commit messages.
4. Push your branch and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgements

• localforage for providing a powerful, simple API for asynchronous storage in web browsers.
• node-localstorage for offering localStorage support in Node.js environments.

About the Author

hidden-gem-storage was created by . For further information or to view other projects, visit GitHub Profile.