Efficient local storage module for Angular: simple API based on native localStorage API, but internally stored via the asynchronous IndexedDB API for performance, and wrapped in RxJS observables to be homogeneous with other Angular modules.

cyrilletuzi

@ngx-pwa/local-storage

import { JSONSchema, JSONSchemaArrayOf, JSONSchemaBoolean, JSONSchemaInteger, JSONSchemaNumber, JSONSchemaString } from "../validation/json-schema";

import { StorageMap } from "./storage-map.service";

 * @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/MIGRATION_TO_V16.md}

 * @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/docs/MIGRATION_TO_V16.md}

     * Number of items in storage wrapped in an `Observable`

     * this.localStorage.length.subscribe((length) => {

     * The signature has many overloads due to validation, **please refer to the documentation.**

     * @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/docs/VALIDATION.md}

     * @param schema Optional JSON schema to validate the data.

     * **Note you must pass the schema directly as the second argument.**

     * **Passing the schema in an object `{ schema }` is deprecated and only here**

     * **for backward compatibility: it will be removed in a future version.**

     * @returns The item's value if the key exists, `null` otherwise, wrapped in a RxJS `Observable`

     * this.localStorage.get('key', { type: 'string' }).subscribe((result) => {

     *     firstName: { type: 'string' },

     * this.localStorage.get<User>('user', schema).subscribe((user) => {

    getItem<T = string>(key: string, schema: JSONSchemaString): Observable<string | null>;

    getItem<T = number>(key: string, schema: JSONSchemaInteger | JSONSchemaNumber): Observable<number | null>;

    getItem<T = boolean>(key: string, schema: JSONSchemaBoolean): Observable<boolean | null>;

    getItem<T = string[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaString>): Observable<string[] | null>;

    getItem<T = number[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaInteger | JSONSchemaNumber>): Observable<number[] | null>;

    getItem<T = boolean[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaBoolean>): Observable<boolean[] | null>;

    getItem<T = unknown>(key: string, schema: JSONSchema | {

    getItem<T = unknown>(key: string, schema?: JSONSchema): Observable<unknown>;

     * Note that setting `null` or `undefined` will remove the item to avoid some browsers issues.

     * @param schema Optional JSON schema to validate the data

     * @returns A RxJS `Observable` to wait the end of the operation

     * this.localStorage.set('key', 'value').subscribe(() => {});

    setItem(key: string, data: unknown, schema?: JSONSchema): Observable<boolean>;

     * this.localStorage.delete('key').subscribe(() => {});

    removeItem(key: string): Observable<boolean>;

     * this.localStorage.clear().subscribe(() => {});

    static ɵfac: i0.ɵɵFactoryDeclaration<LocalStorage, never>;

    static ɵprov: i0.ɵɵInjectableDeclaration<LocalStorage>;

    "url": "https://github.com/sponsors/cyrilletuzi"

  "description": "Efficient local storage module for Angular: simple API based on native localStorage API, but internally stored via the asynchronous IndexedDB API for performance, and wrapped in RxJS observables to be homogeneous with other Angular modules.",

    "url": "https://github.com/cyrilletuzi/angular-async-local-storage.git"

  "homepage": "https://github.com/cyrilletuzi/angular-async-local-storage",

    "url": "https://github.com/cyrilletuzi/angular-async-local-storage/issues"

  "schematics": "./schematics/collection.json",

    "migrations": "./schematics/migration.json"

  "module": "fesm2022/ngx-pwa-local-storage.mjs",

      "esm2022": "./esm2022/ngx-pwa-local-storage.mjs",

      "esm": "./esm2022/ngx-pwa-local-storage.mjs",

      "default": "./fesm2022/ngx-pwa-local-storage.mjs"

		@@ -7,3 +7,3 @@ import { Observable } from "rxjs";
		* @deprecated Will be removed in v17
		* @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/MIGRATION_TO_V16.md}
		* @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/docs/MIGRATION_TO_V16.md}
		*/
		@@ -10,0 +10,0 @@ export declare class LocalStorage {

		{
		"name": "@ngx-pwa/local-storage",
		"version": "16.1.0",
		"version": "16.1.1",
		"funding": {
		@@ -5,0 +5,0 @@ "type": "github",

Improved metrics