DefinitelyTyped/backbone.localstorage/index.d.ts

// Type definitions for backbone.localStorage 1.0.0
// Project: https://github.com/jeromegn/Backbone.localStorage
// Definitions by: Louis Grignon <https://github.com/lgrignon/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import * as Backbone from 'backbone';

declare global {
    const Store: typeof Backbone.LocalStorage;
    type Store = Backbone.LocalStorage;
}

declare module 'backbone' {
    interface Serializer {
        serialize(item: any): any;
        deserialize(data: any): any;
    }

    class LocalStorage {
        name: string;
        serializer: Serializer;
        records: string[];

        constructor(name: string, serializer?: Serializer);

        save(): void;

        // Add a model, giving it a (hopefully)-unique GUID, if it doesn't already
        // have an id of it's own.
        create(model: any): any;

        // Update a model by replacing its copy in `this.data`.
        update(model: any): any;

        // Retrieve a model from `this.data` by id.
        find(model: any): any;

        // Return the array of all models currently in storage.
        findAll(): any;

        // Delete a model from `this.data`, returning it.
        destroy<T>(model: T): T;

        localStorage(): any;

        // Clear localStorage for specific collection.
        _clear(): void;

        _storageSize(): number;

        _itemName(id: any): string;
    }
}