Skip to content

JUGG097/retrieveTokens

Repository files navigation

RetrieveTokens npm github

A simple package for interacting with web client storages like localStorage, bundled using Microbundle.


Guide → InstallationUsageRelease


✨ Features

  • Allow interaction with browser storages like localStorage and sessionStorage with calling them directly.
  • Access and save multiple values to storages iteratively (in progress)

🔧 Installation & Setup

  • Install by running: npm i retrievetokens

📦 Usage & Configuration

  • Fetch key:value stored in storage
// Using ES6 import syntax
import {retrieveValue, retrieveValues} from 'retrievetokens';

// Retrieve token from the local storage
// returns null or value (as a string)
const token = retrieveValue("valueKey", "local");
const tokenObj = retrieveValues(["key1", "key2"], "local");

// Retrieve token from the session storage
// returns null or value (as a string)
const token = retrieveValue("valueKey", "session");
const tokenObj = retrieveValues(["key1", "key2"], "session");
  • Store key:value pair in storage
// Using ES6 import syntax
import {addValue, addValues} from 'retrievetokens';

// Store token in the local storage
// returns true or false (if it fails to store)
const token = addValue("key", "value", "local");
const tokenObj = addValues({ key1: "value", key2: "value2" }, "local");

// Store token in the session storage
// returns true or false (if it fails to store)
const token = addValue("key", "value", "session");
const tokenObj = addValues({ key1: "value", key2: "value2" }, "session");
  • Delete stored key:value pair from storage
// Using ES6 import syntax
import {deleteValue, deleteValues} from 'retrievetokens';

// Delete token from the local storage
// returns true or false (if it fails to delete)
const token = deleteValue("valueKey", "local");
const tokenObj = deleteValues(["key1", "key2"], "local");

// Delete token from the session storage
// returns true or false (if it fails to delete)
const token = deleteValue("valueKey", "session");
const tokenObj = deleteValues(["key1", "key2"], "session");

📦 Releases

  • Tag the latest commit for release
  • Initiate release manually on Github