Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

expirable-storage

wayfair-incubator59.6kMIT1.0.0TypeScript support: included

Expirable data storage based on localStorage and sessionStorage.

expirable-storage, expirable, localstorage, sessionstorage

readme

Expirable storage

OSS Template Version Contributor Covenant

About The Project

Expirable data storage based on localStorage and sessionStorage.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Be sure you use latest stable version of npm:

npm install npm@latest -g

Usage

npm install expirable-storage
# Or
yarn add expirable-storage
import {
  expirableLocalStorage,
  expirableSessionStorage,
} from "expirable-storage";
const expires = 900; // 900 seconds (15 minutes)

expirableLocalStorage.setItem("key1", "value1", expires);
expirableLocalStorage.getItem("key1");

expirableSessionStorage.setItem("key2", "value2", expires);
expirableSessionStorage.getItem("key2");

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Valentin Podkamennyi - @vpodk

Project Link: https://github.com/wayfair-incubator/expirable-storage

Acknowledgements

This template was adapted from https://github.com/othneildrew/Best-README-Template.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.0.0] - 2022-02-14

Added

  • Initial version
  • Pull request template
  • Bug report template
  • Feature request template
  • Contributor Covenant
  • Contribution guidelines
  • Maintainers file
  • README template
  • Security guidance
  • Integrate stale action
  • Dependabot configuration
  • Markdown linting