Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greatefue/greatefue-webstorage

A package that handles LocalStorage, SessionStorage encryption and decryption.
https://github.com/greatefue/greatefue-webstorage

cookie encryption-decryption localstorage sessionstorage websql

Last synced: 2 days ago
JSON representation

A package that handles LocalStorage, SessionStorage encryption and decryption.

Awesome Lists containing this project

README

        

Great Efue Web Storage

A package that encrypt and save/get and decrypt data on web storage.


NPM Version
NPM Downloads
CI


## Table of Contents

1. [Installation](#installation)
2. [Usage](#usage)
3. [Optional Parameter Table](#complete-usage-table)
4. [Releases](./HISTORY.md)
4. [Author](#author)
6. [License](#license)
7. [Team](#team)

## Installation

```bash
$ yarn add greatefue-webstorage
$ npm i greatefue-webstorage
```

## Usage

In your .ts or .js file,

1. import the package

```ts
import { LS_Save, LS_Get } from 'greatefue-webstorage';
```

2. Call the function

```ts or js
LS_Save("key", "data"); //O8tT%PnlxR%M2#dwcuA7Qmzv+sbCk={(-=_!uV@oPHCjX>N{oT@ms+)*(%%^f'I@Dm*(Ym!ER9CpQ3VOGIXV4+G2Ol1iYZj@#$_&
console.log(LS_Get("key")); //data
```

## Complete Usage Table

|**Functions** | **Return Data type** | **Description** | **Example** |
| ------------ |:--------------------:| :------------------------------------------------------- | :-------------------------------------- |
| LS_Save | void | Encrypt and save string value to local storage | ``` LS_Save("key", "data"); ``` |
| LS_Get | string | Get and decrypt string value from local storage | ``` LS_Get("key") ``` |
| LS_SaveObject | void | Encrypt and save object value to local storage | ``` LS_SaveObject("key", {}); ``` |
| LS_GetObject | object | Get and decrypt object value from local storage | ``` LS_GetObject("key") ``` |
| LS_SaveArray | void | Encrypt and save array value to local storage | ``` LS_SaveArray("key", []); ``` |
| LS_GetArray | array | Get and decrypt array value from local storage | ``` LS_SaveArray("key") ``` |
| SS_Save | void | Encrypt and save string value to session storage | ``` SS_Save("key", "data"); ``` |
| SS_Get | string | Get and decrypt string value from session storage | ``` SS_Get("key") ``` |
| SS_SaveObject | void | Encrypt and save object value to session storage | ``` SS_SaveObject("key", {}); ``` |
| SS_GetObject | object | Get and decrypt object value from session storage | ``` SS_GetObject("key") ``` |
| SS_SaveArray | void | Encrypt and save array value to session storage | ``` SS_SaveArray("key", []); ``` |
| SS_GetArray | array | Get and decrypt array value from session storage | ``` SS_SaveArray("key") ``` |

## Author

**Great Efue**

* [GitHub Profile](https://github.com/greatefue)
* [Twitter Profile](https://twitter.com/achillesefue)
* [LinkedIn Profile](https://linkedin.com/in/greatefue)

Please consider supporting me on Patreon.
Become a Patron of Great Efue!

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fgreatefue%2Fgreatefue-webstorage.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fgreatefue%2Fgreatefue-webstorage?ref=badge_large)

## Team

These are folks that keep the project moving and are resources for help.

### Technical Steering Committee (TSC)

The people who manage releases, review feature requests, and meet regularly to ensure GreatEfue-webstorage is properly maintained.





Great Efue

### Reviewers

The people who review and implement new features.




Great Efue

### Committers

The people who review and fix bugs and help triage issues.




Great Efue