Package Exports

@hanspet/js-api
@hanspet/js-api/io

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hanspet/js-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JS-API

A helper methods and an extension to JS arrays, objects, IndexedDb, LocalStorage and SessionStorage , etc...

Installation

npm i --save @hanspet/js-api

The library helper methods for:

Arrays
Objects
List of Values
I/O
Core

I / O

It contains a wrapper for both IndexedDb and the client local storage and session.

IndexedDB Wrapper

import { IdbStore } from "@hanspet/js-api";

const idb = new IdbStore(databaseName);

idb.set(key, data, callback);
//callback is called with true or false.

idb.get(key, callback);
//also returns a promise with the value if callback was not specified.

idb.has(key, callback);
//callback is called with either true or false.

Local Storage and Session Storage Wrapper

import { Store } from "@hanspet/js-api";
/**
 *
 * @param {String} key - A unique key to store data.
 * @param {String} value - the Value to be stored
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.set(key, value, storageType);

/**
 * It returns the stored data using the key and the storage type.
 * If the value was added to by using the Store.append, it returns
 * an array.
 * @param {String} key - A unique key to store data.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.get(key, storageType);

/**
 * It returns true if the key exists in the storage type.
 * @param {String} key - A unique key to store data.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.has(key, type);

/**
 *
 * @param {String} key - A unique key to store data.
 * @param {Object} value - the Value to be stored
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.setObject(key, object, type);

/**
 * It returns the object saved with Store.setObject using the key and the storage type.
 * @param {String} key - A unique key to store data.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */

Store.getObject(key, type);

/**
 *
 * @param {String} key - A unique key to store data.
 * @param {String} value - the Value to be appended to the existing data that was stored with the same key.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.append(key, value, type);

/**
 * It compares the specified value with the data stored against the
 * specified key and returns a boolean.
 * It is case-sensitive.
 * @param {String} key - A unique key to check data.
 * @param {String} value - the Value to be check.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.isEqual(key, value, type);

/**
 * It compares the specified value with the data stored against the
 * specified key and returns a boolean.
 * @param {String} key - A unique key to check data.
 * @param {String} value - the Value to be check.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.isEqualIgnoreCase(key, (value = ""), type);

/**
 * It deletes entry for the specified key in the store.
 * It returns a boolean.
 * @param {String} key - A unique key to check data.
 * @param {Integer} type - Store.Local or Store.Session. Default is Store.Local
 */
Store.delete(key, type);