Narcissistic Piano Mover

    storage-function
    TypeScript icon, indicating that this package has built-in type declarations

    2022.9.10 • Public • Published
    Logo

    Storage Function

    npm npm CodeQL Analyze Build & Test dependabot

    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.

    Table of contents

    Installation

    npm i storage-function

    Breaking Change

    Before 2.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 * as storageFunction from 'storage-function';

    With 2.0.0 version its enough to just import storageFunction 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.

    const localStorageKey = 'local_storage_key';
    
    const localStorageValue = {
      name: 'object value',
      stringValue: 'string value',
      booleanValue: true,
      numberValue: 1234567890,
      dateValue: new Date(),
    };
    - toLocalStorage usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.toLocalStorage(localStorageKey, localStorageValue);
    - fromLocalStorage usage
    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 usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.removeFromLocalStorage(localStorageKey);
    - clearLocalStorage usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.clearLocalStorage(); // Remove all local storage keys
    
    const exceptedKeys = ['some_key', 'another_key'];
    storageFunction.clearLocalStorage(exceptedKeys); // Remove all local storage keys except exceptedKeys
    - getKeysFromLocalStorage usage
    import { storageFunction } from 'storage-function';
    
    console.log(storageFunction.getKeysFromLocalStorage());
    
    Result:
    (2) ["localKey2", "localKey1"]
    0: "localKey2"
    1: "localKey1"
    - getAllFromLocalStorage usage
    import { storageFunction } from 'storage-function';
    
    console.log(storageFunction.getAllFromLocalStorage());
    
    Result:
    (2) [{}, {}]
    0: {localKey2: "\"Local storage value 2\""}
    1: {localKey1: "\"Local storage value 1\""}
    - getKeysCountFromLocalStorage usage
    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.

    const sessionStorageKey = 'session_storage_key';
    
    const sessionStorageValue = {
      name: 'object value',
      stringValue: 'string value',
      booleanValue: true,
      numberValue: 1234567890,
      dateValue: new Date(),
    };
    - toSessionStorage usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.toSessionStorage(sessionStorageKey, sessionStorageValue);
    - fromSessionStorage usage
    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 usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.removeFromSessionStorage(sessionStorageKey);
    - clearSessionStorage usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.clearSessionStorage(); // Remove all session storage keys
    
    const exceptedKeys = ['key_one', 'keyTwo'];
    storageFunction.clearSessionStorage(exceptedKeys); // Remove all session storage keys except exceptedKeys
    - getKeysFromSessionStorage usage
    import { storageFunction } from 'storage-function';
    
    console.log(storageFunction.getKeysFromSessionStorage());
    
    Result:
    (2) ["sessionKey2", "sessionKey1"]
    0: "sessionKey2"
    1: "sessionKey1"
    - getAllFromSessionStorage usage
    import { storageFunction } from 'storage-function';
    
    console.log(storageFunction.getAllFromSessionStorage());
    
    Result:
    (2) [{}, {}]
    0: {sessionKey2: "\"Session storage value 2\""}
    1: {sessionKey1: "\"Session storage value 1\""}
    - getKeysCountFromSessionStorage usage
    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 usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.clearStorage(); // Remove all storage keys
    
    const exceptedKeys = ['id_token', 'access_token'];
    storageFunction.clearStorage(exceptedKeys); // Remove all storage keys except exceptedKeys
    - getKeys usage
    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 usage
    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 usage
    import { storageFunction } from 'storage-function';
    
    storageFunction.toLocalStorage(localStorageKey, localStorageValue);
    storageFunction.toSessionStorage(sessionStorageKey, sessionStorageValue);
    
    console.log(storageFunction.getKeysCount());
    
    Result:
    {localStorage: 1, sessionStorage: 1}

    Install

    npm i storage-function

    DownloadsWeekly Downloads

    33

    Version

    2022.9.10

    License

    MIT

    Unpacked Size

    30 kB

    Total Files

    13

    Last publish

    Collaborators

    • sametcelikbicak