Skip to content

Commit

Permalink
Create type definitions (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
Slessi authored and mattberther committed Jul 12, 2018
1 parent a9d0899 commit b5a896b
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
56 changes: 56 additions & 0 deletions index.d.ts
@@ -0,0 +1,56 @@
declare module "winston-daily-rotate-file" {
import * as Transport from "winston-transport";

interface DailyRotateFileTransportOptions extends Transport.TransportStreamOptions {
json?: boolean;
eol?: string;

/**
* A string representing the moment.js date format to be used for rotating. The meta characters used in this string will dictate the frequency of the file rotation. For example, if your datePattern is simply 'HH' you will end up with 24 log files that are picked up and appended to every day. (default 'YYYY-MM-DD')
*/
datePattern?: string;

/**
* A boolean to define whether or not to gzip archived log files. (default 'false')
*/
zippedArchive?: boolean;

/**
* Filename to be used to log to. This filename can include the %DATE% placeholder which will include the formatted datePattern at that point in the filename. (default: 'winston.log.%DATE%)
*/
filename?: string;

/**
* The directory name to save log files to. (default: '.')
*/
dirname?: string;

/**
* Write directly to a custom stream and bypass the rotation capabilities. (default: null)
*/
stream?: NodeJS.WritableStream;

/**
* Maximum size of the file after which it will rotate. This can be a number of bytes, or units of kb, mb, and gb. If using the units, add 'k', 'm', or 'g' as the suffix. The units need to directly follow the number. (default: null)
*/
maxSize?: string | number;

/**
* Maximum number of logs to keep. If not set, no logs will be removed. This can be a number of files or number of days. If using days, add 'd' as the suffix. (default: null)
*/
maxFiles?: string | number;
}

interface DailyRotateFileTransportInstance extends Transport {
filename: string;
dirname: string;
logStream: NodeJS.WritableStream;
options: DailyRotateFileTransportOptions;

new (options?: DailyRotateFileTransportOptions): DailyRotateFileTransportInstance;
}

const DailyRotateFile: DailyRotateFileTransportInstance;

export = DailyRotateFile;
}
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -3,6 +3,7 @@
"version": "3.2.3",
"description": "A transport for winston which logs to a rotating file each day.",
"main": "index.js",
"types": "index.d.ts",
"engines": {
"node": ">=6"
},
Expand Down

0 comments on commit b5a896b

Please sign in to comment.