{"_id":"storage-encryption","_rev":"11-557eb837422ebd25664c3dcb26a818e1","name":"storage-encryption","dist-tags":{"latest":"1.0.16"},"versions":{"1.0.0":{"name":"storage-encryption","version":"1.0.0","description":"

Welcome to Encrypt Storage šŸ‘‹

\r

\r \r \"Version\"Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"\r \r Welcome to Encrypt Storage šŸ‘‹\r

\r \r \"Version\"\r \r Welcome to Encrypt Storage šŸ‘‹\r\n

\r\n \r\n \"Version\"\r\n \r\n \r\n \"Documentation\"\r\n \r\n \r\n \"Maintenance\"\r\n \r\n \r\n \"License:\r\n \r\n

\r\n\r\n* **Encrypt your storage using AES symmetric encryption algorithm**\r\n\r\n* **JS and TS**\r\n\r\n\r\n### šŸ  [Homepage](https://github.com/nour-karoui/encrypt-storage)\r\n\r\n## Install\r\n\r\n```sh\r\nnpm i storage-encryption\r\n```\r\n\r\n## How it works\r\n\r\n* **The constructor of EncryptStorage takes two arguments:**\r\n * **secret**(required): the secret key (a string) that we'll use in the encryption\r\n * **storage**(optional): localStorage / sessionStorage.\r\n storage is localStorage by default.\r\n \r\n* **Methods provided by encryptStorage:**\r\n * **encrypt**(storage_key: string, data: any): void\r\n * **decrypt**(storage_key: string): any\r\n * **remove**(storage_key: string): void\r\n \r\n\r\n## Encrypt Local/Session Storage (For Typescript)\r\n\r\n```ts\r\nimport {EncryptStorage} from 'storage-encryption';\r\n\r\n// the constructor takes the secret key as a first parameter and an optional\r\n// second parameter as the storage type\r\n// if none is provided it'll be localStorage by default\r\nconst encryptStorage = new EncryptStorage(SECRET_KEY, 'sessionStorage');\r\n/*** for a string ***/\r\nencryptStorage.encrypt('storage_key', 'Hello world');\r\nconst stringValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for an object ***/\r\nencryptStorage.encrypt('storage_key', {'name': 'Hello world'});\r\nconst objectValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for a number ***/\r\nencryptStorage.encrypt('storage_key', 1);\r\nconst numberValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for an array ***/\r\nencryptStorage.encrypt('storage_key', [1, 2, 3]);\r\nconst arrayValue = encryptStorage.decrypt('storage_key');\r\n\r\nencryptStorage.remove('storage_key'); \r\n```\r\n\r\n## Encrypt Local/Session Storage (For Javascript)\r\n```js\r\nconst { EncryptStorage } = require('storage-encryption')\r\n\r\nconst encryptStorage = new EncryptStorage(SECRET_KEY, 'localStorage');\r\n\r\n/*** for a string ***/\r\nencryptStorage.encrypt('storage_key', 'Hello world');\r\nconst stringValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for an object ***/\r\nencryptStorage.encrypt('storage_key', {'name': 'Hello world'});\r\nconst objectValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for a number ***/\r\nencryptStorage.encrypt('storage_key', 1);\r\nconst numberValue = encryptStorage.decrypt('storage_key');\r\n\r\n/*** for an array ***/\r\nencryptStorage.encrypt('storage_key', [1, 2, 3]);\r\nconst arrayValue = encryptStorage.decrypt('storage_key');\r\n\r\nencryptStorage.remove('storage_key'); \r\n```\r\n\r\n## A BETTER WAY TO DO IT\r\n* **Instantiate the encryptStorage object in a shared folder and export it**\r\n* **So you won't have to instantiate it in each file**\r\n\r\n````ts\r\nimport EncryptStorage from 'storage-encryption';\r\n\r\nexport const encryptSessionStorage = EncryptStorage(SECRET_KEY, 'sessionStorage');\r\nexport const encryptLocalStorage = EncryptStorage(SECRET_KEY);\r\n\r\n````\r\n## Author\r\n\r\nšŸ‘¤ **Nour**\r\n\r\n* Github: [@nour-karoui](https://github.com/nour-karoui)\r\n* LinkedIn: [@nourkaroui](https://www.linkedin.com/in/nourkaroui/)\r\n\r\n## šŸ¤ Contributing\r\n\r\nContributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nour-karoui/encrypt-storage/issues). You can also take a look at the [contributing guide](https://github.com/nour-karoui/encrypt-storage/blob/master/CONTRIBUTING.md).\r\n\r\n## Show your support\r\n\r\nGive a [STAR](https://github.com/nour-karoui/encrypt-storage) if this project helped you!\r\n\r\n## šŸ“ License\r\n\r\n* Copyright Ā© 2021 [Nour](https://github.com/nour-karoui).\r\n* This project is [MIT](https://github.com/nour-karoui/encrypt-storage/blob/master/LICENSE) licensed.\r\n\r\n***\r\n_This README was generated with by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\r\n","readmeFilename":"README.md"}