mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-11 11:50:54 +08:00
Add typings for logrotate-stream
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
/// <reference path="logrotate-stream.d.ts" />
|
||||
|
||||
import stream = require("stream");
|
||||
import rotateStream = require("logrotate-stream");
|
||||
|
||||
var s: stream.Writable = rotateStream({
|
||||
file: "mylogfile.log",
|
||||
size: "1m",
|
||||
keep: 3
|
||||
});
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
// Type definitions for logrotate-stream 0.2.5
|
||||
// Project: https://github.com/dstokes/logrotate-stream
|
||||
// Definitions by: Rogier Schouten <https://github.com/rogierschouten>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
/// <reference path="../node/node.d.ts" />
|
||||
declare module "logrotate-stream" {
|
||||
import stream = require("stream");
|
||||
|
||||
// wrapper to be able to use "export =" while also exporting the Options interface
|
||||
module logrotateStream {
|
||||
|
||||
/**
|
||||
* Options object for the exported function.
|
||||
*/
|
||||
export interface Options {
|
||||
/**
|
||||
* The file log file to write data to.
|
||||
*/
|
||||
file: string;
|
||||
/**
|
||||
* The max file size of a log before rotation occurs. Supports 1024, 1k, 1m, 1g
|
||||
*/
|
||||
size: string;
|
||||
/**
|
||||
* The number of rotated log files to keep (including the primary log file). Additional logs are deleted no rotation.
|
||||
*/
|
||||
keep: number;
|
||||
/**
|
||||
* Optionally compress rotated files with gzip.
|
||||
*/
|
||||
compress?: boolean;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a rotating log stream.
|
||||
* @returns a writable stream to a rotating log file
|
||||
*/
|
||||
function logrotateStream(opts: logrotateStream.Options): stream.Writable;
|
||||
|
||||
|
||||
export = logrotateStream;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user