Skip to content

Commit

Permalink
docs: table of options in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michelonsouza committed Aug 12, 2022
1 parent ed5956e commit 8d55789
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Using the `crypto-js` library as an encryption engine, it saves the encrypted da
- [JS Import (ES6+)](#js-import-es6)
- [Multiple instances](#multiple-instances)
- [Options implementation](#options-implementation)
- [All Options](#all-options)
- [*prefix*](#prefix)
- [*storageType*](#storagetype)
- [*stateManagementUse*](#statemanagementuse)
Expand Down Expand Up @@ -151,6 +152,15 @@ in your `storage`:

### Options implementation

#### All Options

|Property name |Default |Type |required |
|----------------------|-----------------|-------------------------------------|----------|
|`prefix` |`''` |`string` |`false` |
|`storageType` |`localStorage` |[StorageType](./src/types.ts#L3) |`false` |
|`encAlgorithm` |`AES` |[EncAlgorithm](./src/types.ts#L1) |`false` |
|`stateManagementUse` |`false` |`boolean` |`false` |

#### *prefix*

default `''` - is optional and is the prefix of all keys used in the selected storage as shown below:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "encrypt-storage",
"version": "2.4.3",
"version": "2.4.4",
"description": "Wrapper for encrypted localStorage and sessionStorage in browser",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 8d55789

Please sign in to comment.