UNPKG

@types/store

Version:
117 lines (105 loc) 3.28 kB
# Installation > `npm install --save @types/store` # Summary This package contains type definitions for store (https://github.com/marcuswestin/store.js#readme). # Details Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/store. ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/store/index.d.ts) ````ts // Cross-browser storage for all use cases, used across the web. interface StoreJsAPI { readonly version: string; readonly enabled: boolean; get(key: string, optionalDefaultValue?: any): any; set(key: string, value: any): any; remove(key: string): void; each(callback: (val: any, namespacedKey: string) => void): void; clearAll(): void; hasNamespace(namespace: string): boolean; createStore(plugins?: Function[], namespace?: string): StoreJsAPI; addPlugin(plugin: Function): void; namespace(namespace: string): StoreJsAPI; } interface StoreJsEngine { createStore(storages: any[], plugins?: any[], namespace?: string): StoreJsAPI; } interface StoreJsStorage { name: string; read: (key: string) => string | null; write: (key: string, data: string) => void; each: (callback: (val: string, key: string) => any) => void; remove: (key: string) => void; clearAll: () => void; } declare const store: StoreJsAPI; declare module "store" { export = store; } declare module "store/dist/store.legacy" { export = store; } declare module "store/dist/store.legacy.min" { export = store; } declare module "store/dist/store.modern" { export = store; } declare module "store/dist/store.modern.min" { export = store; } declare const engine: StoreJsEngine; declare module "store/src/store-engine" { export = engine; } declare module "store/plugins/all" { export = Function; } declare module "store/plugins/defaults" { export = Function; } declare module "store/plugins/dump" { export = Function; } declare module "store/plugins/events" { export = Function; } declare module "store/plugins/expire" { export = Function; } declare module "store/plugins/observe" { export = Function; } declare module "store/plugins/operations" { export = Function; } declare module "store/plugins/update" { export = Function; } declare module "store/plugins/v1-backcompat" { export = Function; } declare const storage: StoreJsStorage; declare module "store/storages/cookieStorage" { export = storage; } declare module "store/storages/localStorage" { export = storage; } declare module "store/storages/memoryStorage" { export = storage; } declare module "store/storages/oldFF-globalStorage" { export = storage; } declare module "store/storages/oldIE-userDataStorage" { export = storage; } declare module "store/storages/sessionStorage" { export = storage; } ```` ### Additional Details * Last updated: Tue, 07 Nov 2023 20:08:00 GMT * Dependencies: none # Credits These definitions were written by [Vincent Bortone](https://github.com/vbortone), [harry0000](https://github.com/harry0000), [Roman Nuritdinov (Ky6uk)](https://github.com/Ky6uk), [Johnny Edwards (igl00)](https://github.com/igl00), and [Jason Kwok (JasonHK)](https://github.com/JasonHK).