nuxt-storage

KO | EN

gitlite — search

#javascript #ai #typescript #android #rust #deep-learning #java #windows #awesome #cli #security #openai #ios #open-source

(★ 128)

🛢 Utilities for easy read and write browser's storage in Nuxt.js project

nuxt-storage 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🛢 Nuxt-Storage
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg)](https://raw.githubusercontent.com/mazipan/nuxt-storage/master/)
![](https://badgen.net/bundlephobia/minzip/nuxt-storage)
[![version](https://img.shields.io/npm/v/nuxt-storage.svg?maxAge=3600)](https://www.npmjs.com/package/nuxt-storage)
[![downloads](https://img.shields.io/npm/dt/nuxt-storage.svg?maxAge=86400)](https://www.npmjs.com/package/nuxt-storage) [![Travis](https://img.shields.io/travis/mazipan/nuxt-storage.svg?maxAge=86400)](https://travis-ci.org/mazipan/nuxt-storage)
[![codecov](https://codecov.io/gh/mazipan/nuxt-storage/branch/master/graph/badge.svg?maxAge=86400)](https://codecov.io/gh/mazipan/nuxt-storage) ![Dependencies](https://img.shields.io/david/mazipan/nuxt-storage.svg)

> Utilities for easy read and write browser's storage in Nuxt.js project

## Why I need this package?

In Nuxt, it's hard to play with browser's storage like `sessionStorage` and `localStorage`.
This package will help you handle client side storage with a simple API and with various useful additional features such as expiry.

## How to install and use

Install using NPM or Yarn

```bash
# NPM
$ npm i nuxt-storage

# Yarn
$ yarn add nuxt-storage
```

## Sample using this package

##### Set data
```js
import nuxtStorage from 'nuxt-storage';

nuxtStorage.localStorage.setData('key', 'value');
nuxtStorage.sessionStorage.setData('key', 'value');

//Set data with expiry time

// default time is 5 minutes, set it to 15
nuxtStorage.localStorage.setData('key', 'value', 15);

// default time unit is minutes , set it to hours, so type 'h'
nuxtStorage.localStorage.setData('key', 'value', 1, 'h');
```
##### Get data by value
```js
nuxtStorage.localStorage.getData('key');
nuxtStorage.sessionStorage.getData('key');
```

##### Remove or clear storage (localStorage/sessionStorage)

```js
// Remove single item by **key**
nuxtStorage.localStorage.removeItem('key');
nuxtStorage.sessionStorage.removeItem('key');

// Clear entire storage
nuxtStorage.localStorage.clear());
nuxtStorage.sessionStorage.clear();
```

## API options

| Method Name | Parameter                         | Default Value | Available Options |
|-------------|-----------------------------------|---------------|-------------------|
| getData     | `key` (type: String)              | Empty String  |  |
| setData     | `key` (type: String)              | Empty String  |  |
|             | `value` (type: any)               | Empty String  |  |
|             | `expiry` (type: Number)           | 5             |  |
|             | `expiryUnit` (type: String)       | m             | `s` = second, `m` = minutes, `h` = hour, `d` = day  |
| removeItem  | `key` (type: String)              |               |  |
| clear       | -                                 |               | | |

## Support me

- 👉 🇮🇩 [Trakteer](https://trakteer.id/mazipan?utm_source=github)
- 👉 🌍 [BuyMeACoffe](https://www.buymeacoffee.com/mazipan?utm_source=github)
- 👉 🌍 [Paypal](https://www.paypal.me/mazipan?utm_source=github)
- 👉 🌍 [Ko-Fi](https://ko-fi.com/mazipan)

-----

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="http://stainfilm.com"><img src="https://avatars0.githubusercontent.com/u/3953002?v=4" width="100px;" alt="notjiam"/> notjiam</a> <a href="https://github.com/mazipan/nuxt-storage/commits?author=notjiam" title="Tests">⚠️</a> <a href="https://github.com/mazipan/nuxt-storage/issues?q=author%3Anotjiam" title="Bug reports">🐛</a></td>
 <td align="center"><a href="https://www.mazipan.xyz/"><img src="https://avatars0.githubusercontent.com/u/7221389?v=4" width="100px;" alt="Irfan Maulana"/> Irfan Maulana</a> <a href="https://github.com/mazipan/nuxt-storage/issues?q=author%3Amazipan" title="Bug reports">🐛</a> <a href="#maintenance-mazipan" title="Maintenance">🚧</a> <a href="https://github.com/mazipan/nuxt-storage/commits?author=mazipan" title="Tests">⚠️</a> <a href="https://github.com/mazipan/nuxt-storage/commits?author=mazipan" title="Code">💻</a></td>
 <td align="center"><a href="https://github.com/devzom"><img src="https://avatars.githubusercontent.com/u/1417473?v=4" width="100px;" alt="Jakub Zomerfeld"/> Jakub Zomerfeld</a> <a href="#" title="Documentation">📝</a></td>
 </tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

nuxt-storage

nuxt-storage 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

nuxt-storage

nuxt-storage 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README