New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
storage-sync-lite
Advanced tools
storage-sync-lite - npm Package Compare versions
Comparing version 1.0.11 to 1.0.12
| { | ||
| "name": "storage-sync-lite", | ||
| "version": "1.0.11", | ||
| "version": "1.0.12", | ||
| "description": "Easily store objects or any type of data to localStorage or sessionStorage.", | ||
@@ -39,2 +39,2 @@ "main": "lib/index.js", | ||
| } | ||
| } | ||
| } |
242
README.md
@@ -1,121 +0,121 @@ | ||
| ��s t o r a g e - s y n c - l i t e < b r > | ||
| [ ! [ N P M V e r s i o n ] ( h t t p s : / / i m g . s h i e l d s . i o / n p m / v / s t o r a g e - s y n c - l i t e . s v g ? b r a n c h = m a i n ) ] ( h t t p s : / / w w w . n p m j s . c o m / p a c k a g e / s t o r a g e - s y n c - l i t e ) | ||
| [ ! [ I n s t a l l S i z e ] ( h t t p s : / / b a d g e n . n e t / p a c k a g e p h o b i a / i n s t a l l / s t o r a g e - s y n c - l i t e ) ] ( h t t p s : / / p a c k a g e p h o b i a . n o w . s h / r e s u l t ? p = s t o r a g e - s y n c - l i t e ) | ||
| [ ! [ L i c e n s e : M I T ] ( h t t p s : / / i m g . s h i e l d s . i o / b a d g e / L i c e n s e - M I T - b l u e . s v g ) ] ( h t t p s : / / o p e n s o u r c e . o r g / l i c e n s e s / M I T ) | ||
| = = = = = = = = = = = = = = = = | ||
| E a s i l y s t o r e o b j e c t s o r a n y t y p e o f d a t a t o l o c a l S t o r a g e o r s e s s i o n S t o r a g e . < b r > | ||
| W h y t h i s ? W h e n y o u s t o r e a J S O N / o b j e c t t o l o c a l S t o r a g e o r s e s s i o n S t o r a g e y o u n e e d t o s t r i n g i f y t h e d a t a . A f t e r s t o r i n g a n u m b e r i n l o c a l S t o r a g e w h e n y o u w i l l r e a d i t , y o u w i l l g e t t h e n u m b e r a s a s t r i n g . B u t s t o r a g e - s y n c - l i t e a l l o w s s t o r i n g a n d r e t r i e v i n g d a t a w i t h o u t c h a n g i n g t h e t y p e . I f y o u s t o r e a n o b j e c t w h e n y o u w i l l r e a d , i t w i l l r e t u r n t h e o b j e c t . | ||
| # # T a b l e o f C o n t e n t s | ||
| - [ F e a t u r e s ] ( # f e a t u r e s ) | ||
| - [ I n s t a l l ] ( # i n s t a l l ) | ||
| - [ U s a g e ] ( # u s a g e ) | ||
| - [ L i c e n s e ] ( # l i c e n s e ) | ||
| - [ A u t h o r ] ( # a u t h o r ) | ||
| # # F e a t u r e s | ||
| - S e t , g e t a n d d e l e t e l o c a l S t o r a g e o r s e s s i o n S t o r a g e w i t h o u t s t r i n g i f y i n g o r c h a n g i n g t h e d a t a t y p e . | ||
| - C h a n g e / u p d a t e o b j e c t s i n l o c a l S t o r a g e o r s e s s i o n S t o r a g e . | ||
| - C l e a r l o c a l S t o r a g e o r s e s s i o n S t o r a g e . | ||
| # # I n s t a l l | ||
| ` ` ` s h | ||
| n p m i s t o r a g e - s y n c - l i t e | ||
| ` ` ` | ||
| # # U s a g e | ||
| S e t a n d g e t l o c a l : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { s e t L o c a l , g e t L o c a l } f r o m ' s t o r a g e - s y n c - l i t e ' | ||
| / / S e t / S t o r e | ||
| s e t L o c a l ( ' u s e r ' , { | ||
| e m a i l : ' u s e r @ e x a m p l e . c o m ' , | ||
| a g e : 2 5 | ||
| } ) | ||
| / / G e t | ||
| l e t u s e r = g e t L o c a l ( ' u s e r ' ) | ||
| c o n s o l e . l o g ( u s e r ) / / R e t u r n s : { e m a i l : ' u s e r @ e x a m p l e . c o m ' , a g e : 2 5 } | ||
| ` ` ` | ||
| C h a n g e / u p d a t e p r o p e r t i e s f r o m l o c a l : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { c h a n g e L o c a l , g e t L o c a l } f r o m ' s t o r a g e - s y n c - l i t e ' | ||
| / / C h a n g e / u p d a t e p r o p e r t i e s | ||
| c h a n g e L o c a l ( ' u s e r ' , { | ||
| n a m e : ' M r . U s e r ' | ||
| } ) | ||
| c o n s o l e . l o g ( g e t L o c a l ( ' u s e r ' ) ) / / R e t u r n s : { e m a i l : ' u s e r @ e x a m p l e . c o m ' , a g e : 2 5 , n a m e : ' M r . U s e r ' } | ||
| ` ` ` | ||
| D e l e t e d a t a f r o m l o c a l : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { d e l e t e L o c a l , c l e a r L o c a l } f r o m ' s t o r a g e - s y n c - l i t e ' | ||
| / / D e l e t e s i n g l e d a t a f r o m l o c a l | ||
| d e l e t e L o c a l ( ' u s e r ' ) | ||
| / / C l e a r / d e l e t e a l l d a t a f r o m l o c a l | ||
| c l e a r L o c a l ( ) | ||
| ` ` ` | ||
| S e t a n d g e t s e s s i o n : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { s e t S e s s i o n , g e t S e s s i o n } f r o m ' s t o r a g e - s y n c - l i t e ' | ||
| / / S e t / S t o r e | ||
| s e t S e s s i o n ( ' u s e r ' , { | ||
| e m a i l : ' u s e r @ e x a m p l e . c o m ' , | ||
| a g e : 2 5 | ||
| } ) | ||
| / / G e t | ||
| l e t u s e r = g e t S e s s i o n ( ' u s e r ' ) | ||
| c o n s o l e . l o g ( u s e r ) / / R e t u r n s : { e m a i l : ' u s e r @ e x a m p l e . c o m ' , a g e : 2 5 } | ||
| ` ` ` | ||
| C h a n g e / u p d a t e p r o p e r t i e s f r o m s e s s i o n : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { c h a n g e S e s s i o n , g e t S e s s i o n } f r o m ' s t o r a g e - s y n c - l i t e ' | ||
| / / C h a n g e / u p d a t e p r o p e r t i e s | ||
| c h a n g e S e s s i o n ( ' u s e r ' , { | ||
| n a m e : ' M r . U s e r ' | ||
| } ) | ||
| c o n s o l e . l o g ( g e t S e s s i o n ( ' u s e r ' ) ) / / R e t u r n s : { e m a i l : ' u s e r @ e x a m p l e . c o m ' , a g e : 2 5 , n a m e : ' M r . U s e r ' } | ||
| ` ` ` | ||
| D e l e t e d a t a f r o m s e s s i o n : | ||
| ` ` ` j a v a s c r i p t | ||
| i m p o r t { d e l e t e S e s s i o n , c l e a r S e s s i o n } f r o m ' i n d e x ' | ||
| / / D e l e t e s i n g l e d a t a f r o m s e s s i o n | ||
| d e l e t e S e s s i o n ( ' u s e r ' ) | ||
| / / C l e a r / d e l e t e a l l d a t a f r o m s e s s i o n | ||
| c l e a r S e s s i o n ( ) | ||
| ` ` ` | ||
| # # L i c e n s e | ||
| s t o r a g e - s y n c - l i t e i s l i c e n s e d u n d e r t h e [ M I T l i c e n s e ] ( h t t p s : / / g i t h u b . c o m / S h e i k h A m i n u l / s t o r a g e - s y n c - l i t e / b l o b / m a i n / L I C E N S E ) . | ||
| # # A u t h o r | ||
| | [ ! [ @ S h e i k h A m i n u l ] ( h t t p s : / / a v a t a r s . g i t h u b u s e r c o n t e n t . c o m / u / 2 5 3 7 2 0 3 9 ? v = 4 & s = 9 6 ) ] ( h t t p s : / / g i t h u b . c o m / S h e i k h A m i n u l ) | | ||
| | : - - - : | | ||
| | [ @ S h e i k h A m i n u l ] ( h t t p s : / / g i t h u b . c o m / S h e i k h A m i n u l ) | | ||
| storage-sync-lite<br> | ||
| [](https://www.npmjs.com/package/storage-sync-lite) | ||
| [](https://packagephobia.now.sh/result?p=storage-sync-lite) | ||
| [](https://opensource.org/licenses/MIT) | ||
| ================ | ||
| Easily store objects or any type of data to localStorage or sessionStorage.<br> | ||
| Why this? When you store a JSON/object to localStorage or sessionStorage you need to stringify the data. After storing a number in localStorage when you will read it, you will get the number as a string. But storage-sync-lite allows storing and retrieving data without changing the type. If you store an object when you will read, it will return the object. | ||
| ## Table of Contents | ||
| - [Features](#features) | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Author](#author) | ||
| ## Features | ||
| - Set, get and delete localStorage or sessionStorage without stringifying or changing the data type. | ||
| - Change/update objects in localStorage or sessionStorage. | ||
| - Clear localStorage or sessionStorage. | ||
| ## Install | ||
| ```sh | ||
| npm i storage-sync-lite | ||
| ``` | ||
| ## Usage | ||
| Set and get local: | ||
| ```javascript | ||
| import { setLocal, getLocal } from 'storage-sync-lite' | ||
| // Set/Store | ||
| setLocal('user', { | ||
| email: 'user@example.com', | ||
| age: 25 | ||
| }) | ||
| // Get | ||
| let user = getLocal('user') | ||
| console.log(user) // Returns: { email: 'user@example.com', age: 25 } | ||
| ``` | ||
| Change/update properties from local: | ||
| ```javascript | ||
| import { changeLocal, getLocal } from 'storage-sync-lite' | ||
| // Change/update properties | ||
| changeLocal('user', { | ||
| name: 'Mr. User' | ||
| }) | ||
| console.log(getLocal('user')) // Returns: { email: 'user@example.com', age: 25, name: 'Mr. User' } | ||
| ``` | ||
| Delete data from local: | ||
| ```javascript | ||
| import { deleteLocal, clearLocal } from 'storage-sync-lite' | ||
| // Delete single data from local | ||
| deleteLocal('user') | ||
| // Clear / delete all data from local | ||
| clearLocal() | ||
| ``` | ||
| Set and get session: | ||
| ```javascript | ||
| import { setSession, getSession } from 'storage-sync-lite' | ||
| // Set/Store | ||
| setSession('user', { | ||
| email: 'user@example.com', | ||
| age: 25 | ||
| }) | ||
| // Get | ||
| let user = getSession('user') | ||
| console.log(user) // Returns: { email: 'user@example.com', age: 25 } | ||
| ``` | ||
| Change/update properties from session: | ||
| ```javascript | ||
| import { changeSession, getSession } from 'storage-sync-lite' | ||
| // Change/update properties | ||
| changeSession('user', { | ||
| name: 'Mr. User' | ||
| }) | ||
| console.log(getSession('user')) // Returns: { email: 'user@example.com', age: 25, name: 'Mr. User' } | ||
| ``` | ||
| Delete data from session: | ||
| ```javascript | ||
| import { deleteSession, clearSession } from 'index' | ||
| // Delete single data from session | ||
| deleteSession('user') | ||
| // Clear / delete all data from session | ||
| clearSession() | ||
| ``` | ||
| ## License | ||
| storage-sync-lite is licensed under the [MIT license](https://github.com/SheikhAminul/storage-sync-lite/blob/main/LICENSE). | ||
| ## Author | ||
| |[](https://github.com/SheikhAminul)| | ||
| |:---:| | ||
| |[@SheikhAminul](https://github.com/SheikhAminul)| |
No alert changes
Improved metrics
- Number of lines in readme file
122
0.83%Worsened metrics
- Total package byte prevSize
6921
-32.12%No dependency changes