Skip to content

๐Ÿ—„๏ธ Implementation of an expirable data storage based on native Web Storage API.

License

Notifications You must be signed in to change notification settings

wayfair-incubator/expirable-storage

Repository files navigation

Expirable storage

OSS Template Version Contributor Covenant Build Status NPM version NPM downloads

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.