Add type definitions for gulp-remember

This commit is contained in:
Thomas Corbière 2015-08-15 12:49:47 +02:00
parent 5109e1269d
commit f9fe170911
2 changed files with 84 additions and 0 deletions

View File

@ -0,0 +1,25 @@
/// <reference path="../gulp/gulp.d.ts" />
/// <reference path="./gulp-remember.d.ts" />
import * as gulp from "gulp";
import remember = require("gulp-remember");
// Usage
gulp.src("*.ts")
.pipe(remember());
gulp.src("*.ts")
.pipe(remember("ts-cache"));
// Drops a file from a remember cache
remember.forget("main.ts");
remember.forget("ts-cache", "main.ts");
// Drops all files from a remember cache
remember.forgetAll();
remember.forgetAll("ts-cache");
// Get a raw remember cache
remember.cacheFor();
remember.cacheFor("ts-cache");
remember.cacheFor("ts-cache")["main.ts"];

59
gulp-remember/gulp-remember.d.ts vendored Normal file
View File

@ -0,0 +1,59 @@
// 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/borisyankov/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;
}