DegreeSign - Web Storage System

More Info

Node Integration

Install using yarn add @degreesign/storage or npm install @degreesign/storage

import {
    configureStorage,
    saveData,
    readData,
    saveSecure,
    readSecure,
} from "@degreesign/storage";

Browser Integration

Use in browsers through CDN

<script 
    src="https://cdn.jsdelivr.net/npm/@degreesign/storage@1.0.9/dist/browser/degreesign.min.js"
></script>

const {
    configureStorage,
    saveData,
    readData,
    saveSecure,
    readSecure,
} = window.stored;

Usage

// configure storage system
await configureStorage({
    storageKey: 'app_name',
    dbName: 'database_name',
    storeName: 'dataset_name',
    encryptionKey: 'encryption_key',
    hideErrors: true,
});

// sample data
const 
    key = `sample_key`,
    data: SampleType = { id: `1`, name: 'Hasn', email: 'hasn@example.com' };

/** quick unencrypted, only suitable for smaller data */
// save 
saveData({ key, data });
// read
const unsecureData = readData<SampleType>(key);
console.log(`unsecureData`, unsecureData);
// clear
saveData({ key });


/** secure, useful for larger data */
// save
await saveSecure({ key, data });
// read
const secureData = await readSecure<SampleType>(key);
console.log(`secureData`, secureData);
// clear
await saveSecure({ key });