Logo for jsDocs.io

ng2-webstorage

  • Version 2.0.0
  • Published
  • No dependencies
  • MIT license

Install

npm i ng2-webstorage
yarn add ng2-webstorage
pnpm add ng2-webstorage

Overview

Angular webstorage manager

Index

Variables

Functions

Classes

Interfaces

Variables

variable WEBSTORAGE_CONFIG

const WEBSTORAGE_CONFIG: InjectionToken<{}>;

    Functions

    function LocalStorage

    LocalStorage: (
        webSKey?: string,
        defaultValue?: any
    ) => (targetedClass: Object, raw: string) => void;

      function provideConfig

      provideConfig: (config: IWebstorageConfig) => WebstorageConfig;

        function SessionStorage

        SessionStorage: (
            webSKey?: string,
            defaultValue?: any
        ) => (targetedClass: Object, raw: string) => void;

          function WebStorage

          WebStorage: (
              webSKey: string,
              sType: STORAGE,
              defaultValue?: any
          ) => (targetedClass: Object, raw: string) => void;

            function WebStorageDecorator

            WebStorageDecorator: (
                webSKey: string,
                sType: STORAGE,
                targetedClass: Object,
                raw: string,
                defaultValue?: any
            ) => void;

              Classes

              class LocalStorageService

              class LocalStorageService extends WebStorageService implements IStorage {}

                constructor

                constructor();

                  class Ng2Webstorage

                  class Ng2Webstorage {}

                    constructor

                    constructor(ngZone: NgZone, config: WebstorageConfig);

                      method forRoot

                      static forRoot: (config?: IWebstorageConfig) => ModuleWithProviders;

                        class SessionStorageService

                        class SessionStorageService extends WebStorageService implements IStorage {}

                          constructor

                          constructor();

                            class WebstorageConfig

                            class WebstorageConfig implements IWebstorageConfig {}

                              constructor

                              constructor(config?: IWebstorageConfig);

                                property caseSensitive

                                caseSensitive: boolean;

                                  property prefix

                                  prefix: string;

                                    property separator

                                    separator: string;

                                      class WebStorageService

                                      class WebStorageService implements IStorage {}

                                        constructor

                                        constructor(sType?: STORAGE);

                                          method clear

                                          clear: (raw?: string) => void;

                                            method isStorageAvailable

                                            isStorageAvailable: () => boolean;

                                              method observe

                                              observe: (raw: string) => EventEmitter<any>;

                                                method retrieve

                                                retrieve: (raw: string) => any;

                                                  method store

                                                  store: (raw: string, value: any) => void;

                                                    Interfaces

                                                    interface IStorage

                                                    interface IStorage {}

                                                      method clear

                                                      clear: (key?: string) => void;

                                                        method observe

                                                        observe: (key: string) => EventEmitter<any>;

                                                          method retrieve

                                                          retrieve: (key: string) => any;

                                                            method store

                                                            store: (key: string, value: any) => void;

                                                              interface IWebStorage

                                                              interface IWebStorage {}

                                                                property getItem

                                                                getItem: (key: string) => string;

                                                                  property removeItem

                                                                  removeItem: (key: string) => void;

                                                                    property setItem

                                                                    setItem: (key: string, value: string) => void;

                                                                      interface IWebstorageConfig

                                                                      interface IWebstorageConfig {}

                                                                        property caseSensitive

                                                                        caseSensitive?: boolean;

                                                                          property prefix

                                                                          prefix?: string;

                                                                            property separator

                                                                            separator?: string;

                                                                              Package Files (10)

                                                                              Dependencies (0)

                                                                              No dependencies.

                                                                              Dev Dependencies (35)

                                                                              Peer Dependencies (1)

                                                                              Badge

                                                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ng2-webstorage.

                                                                              • Markdown
                                                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ng2-webstorage)
                                                                              • HTML
                                                                                <a href="https://www.jsdocs.io/package/ng2-webstorage"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>