ztimson/webstorage-decorators
ztimson/webstorage-decorators
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Updated docs

Browse Source
This commit is contained in:
Zakary Timson 2021-02-02 00:05:08 -05:00
parent e339af3874
commit f27014af14
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -9,14 +9,15 @@ for persisting themes or local settings over reloads or maintaining filters/sear
import {LocalStorage, SessionStorage} from 'webstorage-decorators'; import {LocalStorage, SessionStorage} from 'webstorage-decorators';
export class MyCustomClass { export class MyCustomClass {
@LocalStorage({key: 'site_theme', default: 'light_theme'}) theme: string; @LocalStorage('light_theme', {key: 'site_theme'}) theme: string;
@SessionStorage({encryptWith: config.entryptionKey}) thisUser: User; @SessionStorage(null, {encryptWith: config.entryptionKey}) thisUser: User;
@SessionStorage() searchBar: string;
constructor() { constructor() {
console.log(this.theme, localStorage.getItem('theme')); // Output: 'light_theme', 'light_theme' console.log(this.theme, localStorage.getItem('theme')); // Output: 'light_theme', 'light_theme'
console.log(this.user, localStorage.getItem('user')); // Output: null, undefined console.log(this.user, localStorage.getItem('user')); // Output: null, undefined
user = {first: 'John', last: 'Smith', ...} user = {first: 'John', last: 'Smith', ...}
console.log(this.user, this.user == localStorage.getItem('user')); // Output: {first: 'John', last: 'Smith', ...}, true console.log(this.user, localStorage.getItem('user')); // Output: {first: 'John', last: 'Smith', ...}, **Some encrypted value**
} }
} }
``` ```

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "webstorage-decorators", "name": "webstorage-decorators",
"version": "3.2.5", "version": "3.2.6",
"description": "Decorators to sync class properties to Local/Session storage", "description": "Decorators to sync class properties to Local/Session storage",
"repository": "https://github.com/ztimson/WebstorageDecorators", "repository": "https://github.com/ztimson/WebstorageDecorators",
"main": "./lib/index.js", "main": "./lib/index.js",