This repository was archived by the owner on Apr 30, 2024. It is now read-only.

sametcelikbicak/storage-functionPublic archive

NotificationsYou must be signed in to change notification settings
Fork0
Star11

A function to manipulate browser storages, v2023.3.19 is ready on NPM

www.npmjs.com/package/storage-function

License

MIT license

11 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 264 Commits
.github		.github
assets		assets
scripts		scripts
src		src
test		test
.all-contributorsrc		.all-contributorsrc
.gitignore		.gitignore
.prettierrc		.prettierrc
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
jestconfig.json		jestconfig.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
tslint.json		tslint.json

Repository files navigation

Storage Function

A function to manipulate browser storages. Such as store a key value pair to session or local storage, getting key value pairs from local or session storage.You can check all available functions for more details.

Installation

npm i storage-function

Breaking Change

Before2.0.0 version each function should be import itself like below

import{toLocalStorage,toSessionStorage}from'storage-function';

or import them with an alias like below

import*asstorageFunctionfrom'storage-function';

With2.0.0 version its enough to just importstorageFunction then you can reach all helpful function under it like below.

import{storageFunction}from'storage-function';

Usage

Local storage key and value definitions

Sample key and value definition for testing local storage functions.

constlocalStorageKey='local_storage_key';constlocalStorageValue={name:'object value',stringValue:'string value',booleanValue:true,numberValue:1234567890,dateValue:newDate(),};

toLocalStorage

import{storageFunction}from'storage-function';storageFunction.toLocalStorage(localStorageKey,localStorageValue);

fromLocalStorage

import{storageFunction}from'storage-function';console.log(storageFunction.fromLocalStorage(localStorageKey));Result:{"name":"object value","stringValue":"string value","booleanValue":true,"numberValue":1234567890,"dateValue":"2021-08-22T15:57:05.147Z"}

removeFromLocalStorage

import{storageFunction}from'storage-function';storageFunction.removeFromLocalStorage(localStorageKey);

clearLocalStorage

import{storageFunction}from'storage-function';storageFunction.clearLocalStorage();// Remove all local storage keysconstexceptedKeys=['some_key','another_key'];storageFunction.clearLocalStorage(exceptedKeys);// Remove all local storage keys except exceptedKeys

getKeysFromLocalStorage

import{storageFunction}from'storage-function';console.log(storageFunction.getKeysFromLocalStorage());Result:(2)["localKey2","localKey1"]0:"localKey2"1:"localKey1"

getAllFromLocalStorage

import{storageFunction}from'storage-function';console.log(storageFunction.getAllFromLocalStorage());Result:(2)[{…},{…}]0:{localKey2:"\"Local storage value 2\""}1:{localKey1:"\"Local storage value 1\""}

getKeysCountFromLocalStorage

import{storageFunction}from'storage-function';storageFunction.toLocalStorage(localStorageKey,localStorageValue);console.log(storageFunction.getKeysCountFromLocalStorage());Result:1

Session storage key and value definitions

Sample key and value definition for testing session storage functions.

constsessionStorageKey='session_storage_key';constsessionStorageValue={name:'object value',stringValue:'string value',booleanValue:true,numberValue:1234567890,dateValue:newDate(),};

toSessionStorage

import{storageFunction}from'storage-function';storageFunction.toSessionStorage(sessionStorageKey,sessionStorageValue);

fromSessionStorage

import{storageFunction}from'storage-function';console.log(storageFunction.fromSessionStorage(sessionStorageKey));Result:{"name":"object value","stringValue":"string value","booleanValue":true,"numberValue":1234567890,"dateValue":"2021-08-22T15:58:28.646Z"}

removeFromSessionStorage

import{storageFunction}from'storage-function';storageFunction.removeFromSessionStorage(sessionStorageKey);

clearSessionStorage

import{storageFunction}from'storage-function';storageFunction.clearSessionStorage();// Remove all session storage keysconstexceptedKeys=['key_one','keyTwo'];storageFunction.clearSessionStorage(exceptedKeys);// Remove all session storage keys except exceptedKeys

getKeysFromSessionStorage

import{storageFunction}from'storage-function';console.log(storageFunction.getKeysFromSessionStorage());Result:(2)["sessionKey2","sessionKey1"]0:"sessionKey2"1:"sessionKey1"

getAllFromSessionStorage

import{storageFunction}from'storage-function';console.log(storageFunction.getAllFromSessionStorage());Result:(2)[{…},{…}]0:{sessionKey2:"\"Session storage value 2\""}1:{sessionKey1:"\"Session storage value 1\""}

getKeysCountFromSessionStorage

import{storageFunction}from'storage-function';storageFunction.toSessionStorage(sessionStorageKey,sessionStorageValue);console.log(storageFunction.getKeysCountFromSessionStorage());Result:1

Storage functions definition

They work with local and session storage.

clearStorage

import{storageFunction}from'storage-function';storageFunction.clearStorage();// Remove all storage keysconstexceptedKeys=['id_token','access_token'];storageFunction.clearStorage(exceptedKeys);// Remove all storage keys except exceptedKeys

getKeys

import{storageFunction}from'storage-function';console.log(storageFunction.getKeys());Result:{localStorage:Array(2),sessionStorage:Array(2)}localStorage:(2)["localKey2","localKey1"]sessionStorage:(2)["sessionKey2","sessionKey1"]

getAll

import{storageFunction}from'storage-function';console.log(storageFunction.getAll());Result:{localStorage:Array(2),sessionStorage:Array(2)}localStorage:Array(2)0:{localKey2:"\"Local storage value 2\""}1:{localKey1:"\"Local storage value 1\""}sessionStorage:Array(2)0:{sessionKey2:"\"Session storage value 2\""}1:{sessionKey1:"\"Session storage value 1\""}

getKeysCount

import{storageFunction}from'storage-function';storageFunction.toLocalStorage(localStorageKey,localStorageValue);storageFunction.toSessionStorage(sessionStorageKey,sessionStorageValue);console.log(storageFunction.getKeysCount());Result:{localStorage:1,sessionStorage:1}

Want to contribute?

You can read and follow ourCONTRIBUTING.md and report it usingGitHub Issues! for reporting bugs, suggesting enhancements, bugfixes, new features and extras are welcome.