gulp-remember.d.ts

// Type definitions for gulp-remember
// Project: https://github.com/ahaurw01/gulp-remember
// Definitions by: Thomas Corbière <https://github.com/tomc974>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../node/node.d.ts"/>

declare module "gulp-remember"
{
    interface ICache
    {
        [path: string]: NodeJS.ReadWriteStream;
    }

    interface IGulpRemember
    {
        /**
         * Return a through stream that will:
         *   1. Remember all files that ever pass through it.
         *   2. Add all remembered files back into the stream when not present.
         * @param cacheName Name to give your cache
         */
        (cacheName?: string): NodeJS.ReadWriteStream;

        /**
         * Forget about a file.
         * A warning is logged if either the named cache or file do not exist.
         * @param path Path of the file to forget
         */
        forget(path: string): void;

        /**
         * Forget about a file.
         * A warning is logged if either the named cache or file do not exist.
         * @param cacheName Name of the cache from which to drop the file
         * @param path Path of the file to forget
         */
        forget(cacheName: string, path: string): void;

        /**
         * Forget all files in one cache.
         * A warning is logged if the cache does not exist.
         *
         * @param cacheName Name of the cache to wipe
         */
        forgetAll(cacheName?: string): void;

        /**
         * Return a raw cache by name.
         * Useful for checking state. Manually adding or removing files is NOT recommended.
         *
         * @param cacheName Name of the cache to retrieve
         */
        cacheFor(cacheName?: string): ICache;
    }

    const remember: IGulpRemember;
    export = remember;
}