ngforage
Version:
localForage bindings for Angular
134 lines • 13.2 kB
JavaScript
import { Injectable } from '@angular/core';
import { BaseConfigurableImpl } from '../config';
import * as i0 from "@angular/core";
/**
* Cache instance
*/
export class NgForage extends BaseConfigurableImpl {
/**
* Returns the name of the driver being used, or null if none can be used.
*/
get activeDriver() {
return this.store.driver();
}
/**
* When invoked with no arguments, it drops the “store” of the current instance. When invoked with an object
* specifying both name and storeName properties, it drops the specified “store”. When invoked with an object
* specifying only a name property, it drops the specified “database” (and all its stores).
*/
async dropInstance(cfg) {
return await (cfg ? this.store.dropInstance(cfg) : this.store.dropInstance());
}
/**
* Removes every key from the database, returning it to a blank slate.
*
* clear() will remove <b>every item in the offline store</b>. Use this method with caution.
*/
async clear() {
return await this.store.clear();
}
/**
* Make a clone of the instance
* @param config Optional configuration
*/
clone(config) {
const inst = new NgForage(this.baseConfig, this.fact);
inst.configure({ ...this.finalConfig, ...config });
return inst;
}
/**
* Gets an item from the storage library.
* If the key does not exist, getItem() will return null.
* @param key Data key
*/
async getItem(key) {
return await this.store.getItem(key);
}
/**
* Iterate over all value/key pairs in datastore.
* <i>iteratee</i> is called once for each pair, with the following arguments:
* <ol>
* <li>Value</li>
* <li>Key</li>
* <li>iterationNumber - one-based number</li>
* </ol>
* iterate() supports early exit by returning a non-`undefined` value inside iteratorCallback callback.
* @param iteratee
*/
async iterate(iteratee) {
return await this.store.iterate(iteratee);
}
/**
* Get the name of a key based on its ID.
* @param index
*/
async key(index) {
return await this.store.key(index);
}
/**
* Get the list of all keys in the datastore.
*/
async keys() {
return await this.store.keys();
}
/**
* Gets the number of keys in the offline store (i.e. its “length”).
*/
async length() {
return await this.store.length();
}
/**
* Even though localForage queues up all of its data API method calls,
* ready() provides a way to determine whether the asynchronous driver initialization process has finished.
* That’s useful in cases like when we want to know which driver localForage has settled down using.
*/
async ready() {
return await this.store.ready();
}
/**
* Removes the value of a key from the offline store.
* @param key Data key
*/
async removeItem(key) {
return await this.store.removeItem(key);
}
/**
* Saves data to an offline store. You can store the following types of JavaScript objects:
* <ul>
* <li>Array</li>
* <li>ArrayBuffer</li>
* <li>Blob</li>
* <li>Float32Array</li>
* <li>Float64Array</li>
* <li>Int8Array</li>
* <li>Int16Array</li>
* <li>Int32Array</li>
* <li>Number</li>
* <li>Object</li>
* <li>Uint8Array</li>
* <li>Uint8ClampedArray</li>
* <li>Uint16Array</li>
* <li>Uint32Array</li>
* <li>String</li>
* </ul>
* @param key Data key
* @param data Data
*/
async setItem(key, data) {
return await this.store.setItem(key, data);
}
/**
* Check whether the given driver is supported/registered.
* @param driver Driver name
*/
supports(driver) {
return this.store.supports(driver);
}
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: NgForage, deps: null, target: i0.ɵɵFactoryTarget.Injectable });
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: NgForage, providedIn: 'root' });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: NgForage, decorators: [{
type: Injectable,
args: [{ providedIn: 'root' }]
}] });
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ng-forage.service.js","sourceRoot":"","sources":["../../../../../projects/ngforage/src/lib/main/ng-forage.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAC,oBAAoB,EAAC,MAAM,WAAW,CAAC;;AAI/C;;GAEG;AAEH,MAAM,OAAO,QAAS,SAAQ,oBAAoB;IAEhD;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,GAAkC;QAC1D,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK;QAChB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAwB;QACnC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,SAAS,CAAC,EAAC,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,MAAM,EAAC,CAAC,CAAC;QAEjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAI,GAAW;QACjC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAI,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO,CAAO,QAA+D;QACxF,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,CAAC,KAAa;QAC5B,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK;QAChB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,GAAW;QACjC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,OAAO,CAAI,GAAW,EAAE,IAAO;QAC1C,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAI,GAAG,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,MAAuB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAS,MAAM,CAAC,CAAC;IAC7C,CAAC;uGArIU,QAAQ;2GAAR,QAAQ,cADI,MAAM;;2FAClB,QAAQ;kBADpB,UAAU;mBAAC,EAAC,UAAU,EAAE,MAAM,EAAC","sourcesContent":["import {Injectable} from '@angular/core';\nimport type {BaseConfigurable, NgForageOptions} from '../config';\nimport {BaseConfigurableImpl} from '../config';\nimport type {DriverType} from '../misc/driver-type.type';\nimport {Driver} from '../misc/driver.enum';\n\n/**\n * Cache instance\n */\n@Injectable({providedIn: 'root'})\nexport class NgForage extends BaseConfigurableImpl implements BaseConfigurable {\n\n  /**\n   * Returns the name of the driver being used, or null if none can be used.\n   */\n  public get activeDriver(): DriverType {\n    return this.store.driver();\n  }\n\n  /**\n   * When invoked with no arguments, it drops the “store” of the current instance. When invoked with an object\n   * specifying both name and storeName properties, it drops the specified “store”. When invoked with an object\n   * specifying only a name property, it drops the specified “database” (and all its stores).\n   */\n  public async dropInstance(cfg?: LocalForageDbInstanceOptions): Promise<void> {\n    return await (cfg ? this.store.dropInstance(cfg) : this.store.dropInstance());\n  }\n\n  /**\n   * Removes every key from the database, returning it to a blank slate.\n   *\n   * clear() will remove <b>every item in the offline store</b>. Use this method with caution.\n   */\n  public async clear(): Promise<void> {\n    return await this.store.clear();\n  }\n\n  /**\n   * Make a clone of the instance\n   * @param config Optional configuration\n   */\n  public clone(config?: NgForageOptions): NgForage {\n    const inst = new NgForage(this.baseConfig, this.fact);\n    inst.configure({...this.finalConfig, ...config});\n\n    return inst;\n  }\n\n  /**\n   * Gets an item from the storage library.\n   * If the key does not exist, getItem() will return null.\n   * @param key Data key\n   */\n  public async getItem<T>(key: string): Promise<T | null> {\n    return await this.store.getItem<T>(key);\n  }\n\n  /**\n   * Iterate over all value/key pairs in datastore.\n   * <i>iteratee</i> is called once for each pair, with the following arguments:\n   * <ol>\n   *   <li>Value</li>\n   *   <li>Key</li>\n   *   <li>iterationNumber - one-based number</li>\n   * </ol>\n   * iterate() supports early exit by returning a non-`undefined` value inside iteratorCallback callback.\n   * @param iteratee\n   */\n  public async iterate<T, U>(iteratee: (value: T, key: string, iterationNumber: number) => U): Promise<U> {\n    return await this.store.iterate(iteratee);\n  }\n\n  /**\n   * Get the name of a key based on its ID.\n   * @param index\n   */\n  public async key(index: number): Promise<string> {\n    return await this.store.key(index);\n  }\n\n  /**\n   * Get the list of all keys in the datastore.\n   */\n  public async keys(): Promise<string[]> {\n    return await this.store.keys();\n  }\n\n  /**\n   * Gets the number of keys in the offline store (i.e. its “length”).\n   */\n  public async length(): Promise<number> {\n    return await this.store.length();\n  }\n\n  /**\n   * Even though localForage queues up all of its data API method calls,\n   * ready() provides a way to determine whether the asynchronous driver initialization process has finished.\n   * That’s useful in cases like when we want to know which driver localForage has settled down using.\n   */\n  public async ready(): Promise<void> {\n    return await this.store.ready();\n  }\n\n  /**\n   * Removes the value of a key from the offline store.\n   * @param key Data key\n   */\n  public async removeItem(key: string): Promise<void> {\n    return await this.store.removeItem(key);\n  }\n\n  /**\n   * Saves data to an offline store. You can store the following types of JavaScript objects:\n   * <ul>\n   *  <li>Array</li>\n   *  <li>ArrayBuffer</li>\n   *  <li>Blob</li>\n   *  <li>Float32Array</li>\n   *  <li>Float64Array</li>\n   *  <li>Int8Array</li>\n   *  <li>Int16Array</li>\n   *  <li>Int32Array</li>\n   *  <li>Number</li>\n   *  <li>Object</li>\n   *  <li>Uint8Array</li>\n   *  <li>Uint8ClampedArray</li>\n   *  <li>Uint16Array</li>\n   *  <li>Uint32Array</li>\n   *  <li>String</li>\n   * </ul>\n   * @param key Data key\n   * @param data Data\n   */\n  public async setItem<T>(key: string, data: T): Promise<T> {\n    return await this.store.setItem<T>(key, data);\n  }\n\n  /**\n   * Check whether the given driver is supported/registered.\n   * @param driver Driver name\n   */\n  public supports(driver: Driver | string): boolean {\n    return this.store.supports(<string>driver);\n  }\n}\n"]}