indexed-db-utilities/src/demos/demo.ts

Helper methods and utilities for creating managing values dynamically for the browser's IndexDB API.

//tslint:disable
import {openIDBUtilities} from "../utilities/index-db.utility";

async function demo() {

	/**
	 *
	 * Call openIDBUtilities(config) with config parameters to open an IndexedDB and return a promise that holds
	 * an Object with helper methods, add(), put(), update(), get() and remove().
     * if one doesn't exsist then it will be made. Note: Once ObjectStores are defined they
     * IDBs version number and to add more you must provide a new version number.
     *
     *  The Config Object = {
     *      version: Number
     *      dbName: String
     *      storeNames: String[]
     *      keyPath?: String
     *	}
     *
     **/

	console.log('calling open');
	const stores = await openIDBUtilities({
		version: 3, // Numbers should be a positive Number and not contain any decimal digits.
		dbName: 'DemoIDB-2',
		storeNames: ['demoStore0', 'demoStore1', "demoStore2"], // Provide and array of the storeNames in which you wish to store values in.
		keyPath: 'myKey' // keyPath is optional, if provided this will be how you get selective values from the stores and must be a property in your object value you wish to store. If omitted the stores will be indexed 0 to (n-1);
	});
	console.log('stores', stores);

	/**
	 * 	add(storeName: string, value: any) => Promise<string | {}>;
	 * 	Returns a string with the saved value's key or Request.Result Object.
	 * 	Note: You cannot add new values to objects with keys that already exsist, use put() or update().
	 */
	console.log('calling add');
	const addResponse = await stores.add(
		'demoStore0',
		{
			myKey: 'foo',
			value: [{ bat: 'squeak'}, {bear: 'grrr'}]
		})
		.catch(err => console.log('Add Error: ', err));
	console.log('add response', addResponse); // add response foo

	/**
	 *  get(storeName: string, key: string) => Promise<any>;
	 *  Returns the value stored that matches the value stored in [keyPath]: String
	 *  or throws an Request.Result Object
	 */
	console.log('calling get');
	let getResponse = await stores.get('demoStore0', 'foo');
	console.log('get response', getResponse); // get response {myKey:'foo', value: [{ bat: 'squeak'}, {bear: 'grrr'}]}

	/**
	 *  put(storeName: string, value: any) => Promise<string | {}>;
	 *  Returns a string with the saved value's key or throws Request.Result Object.
	 *  Note: This will overwrite your value saved related your key.
	 */
	console.log('calling put');
	const putResponse = await stores.put(
		'demoStore0',
		{
			myKey: 'foo',
			value: [{ cat: 'meow'}]
		})
		.catch( err => `Put Error: ${err}`);

	console.log('put response', putResponse); // put response foo
	getResponse = await stores.get('demoStore0', 'foo');
	console.log('get response', getResponse); // {myKey:'foo', value: [{cat: 'meow'}]}

	/**
	 *  update(storeName: string, key: string, value: any) => Promise<string | {}>;
	 *  Returns a string with the updated value's key or throws an Request.Result Object.
	 *  Note: This will merge with your stored value, if it is an array it will concatenate
	 *  the new values.
	 */
	console.log('calling update');
	const updateResponse = await stores.update(
		'demoStore0',
		'foo',
		{
			myKey: 'foo',
			value: [{ bat: 'squeak'}, {bear: 'grrr', dog: ['woof', 'bark']}, {cat: 'purr'}, ['happy hacking!']]
		})
		.catch( err => `Update Error: ${err}`);
	console.log('update response', updateResponse); // update response foo
	getResponse = await stores.get('demoStore0', 'foo');
	console.log('get response', getResponse); // get response {myKey:'foo', value: [{cat: 'meow'}, { bat: 'squeak'}, {bear: 'grrr', dog: ['woof', 'bark']}, {cat: 'purr'}, ['happy hacking!']]}

	/**
	 * getAll (storeName: string) => Promise<{}>
	 * Returns all values in the store.
	 */
	for (let i = 0; i < 10; i++) {
		await stores.put('demoStore0', {
			myKey: i.toString(),
			value: i
		})
	}
	const getAllResponse = await stores.getAll('demoStore0');
	console.log('getAll Response', getAllResponse);
	/**
	 *  remove(storeName: string, key: string) => Promise<any>;
	 *  returns void or throws an Request.Result Object
	 */
	console.log('calling remove');
	const removeResponse = await stores.remove('demoStore0', 'foo')
		.catch(err => console.log('remove error', err));
	console.log('removeResponse', removeResponse); // removeResponse undefined

	// Removing values from getAll Demo
	for (let i = 0; i < 10; i++) {
		await stores.remove('demoStore0', i.toString())
			.catch(err => console.log('Remove Error', err));
	}
}
console.log('calling demo');
demo()
	.then(res => console.log('response', res))
	.catch(err => console.log('Error: ', err));