@types/angular-storage
TypeScript icon, indicating that this package has built-in type declarations

0.0.36 • Public • Published

Installation

npm install --save @types/angular-storage

Summary

This package contains type definitions for angular-storage (https://github.com/auth0/angular-storage).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/angular-storage.

index.d.ts

/// <reference types="angular" />

declare var _: string;
export = _;

import * as angular from "angular";

declare module "angular" {
    namespace a0.storage {
        interface IStoreService extends INamespacedStoreService {
            /**
             * Returns a namespaced store
             *
             * @param {String} namespace - The namespace
             * @param {String} storage - The name of the storage service. Defaults to local storage.
             * @param {String} delimiter - The delimiter to use to separate the namespace and the keys.
             * @returns {INamespacedStoreService}
             */
            getNamespacedStore(namespace: string, storage?: string, delimiter?: string): INamespacedStoreService;
        }

        interface INamespacedStoreService {
            /**
             * Sets a new value to the storage with the key name. It can be any object.
             *
             * @param {String} name - The key name for the location of the value
             * @param value - The value to store
             */
            set(name: string, value: any): void;

            /**
             * Returns the saved value with they key name.
             *
             * @param {String} name - The key name for the location of the value
             * @returns The saved value; if you saved an object, you get an object
             */
            get(name: string): any;

            /**
             * Deletes the saved value with the key name
             *
             * @param {String} name - The key name for the location of the value to remove
             */
            remove(name: string): void;
        }

        interface IStoreProvider {
            /**
             * Sets the storage.
             *
             * @param {String} storage - The storage name
             */
            setStore(storage: string): void;
        }
    }
}

Additional Details

  • Last updated: Mon, 06 Nov 2023 22:41:04 GMT
  • Dependencies: @types/angular

Credits

These definitions were written by Matthew DeKrey.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/angular-storage

Weekly Downloads

310

Version

0.0.36

License

MIT

Unpacked Size

6.48 kB

Total Files

5

Last publish

Collaborators

  • types