Skip to content

Commit

Permalink
update definition to export the interfaces along with class
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamerkumar authored and mattberther committed Nov 6, 2018
1 parent f1d1ff0 commit dc9404b
Showing 1 changed file with 55 additions and 59 deletions.
114 changes: 55 additions & 59 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,61 +1,57 @@
declare module "winston-daily-rotate-file" {
import * as Transport from "winston-transport";

import * as Transport from 'winston-transport';
declare namespace DailyRotateFile {
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;

/**
* An object resembling https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options indicating additional options that should be passed to the file stream. (default: `{ flags: 'a' }`)
*/
options?: string | object;
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;
/**
* An object resembling https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options indicating additional options that should be passed to the file stream. (default: `{ flags: 'a' }`)
*/
options?: string | object;
}

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

new (options?: DailyRotateFileTransportOptions): DailyRotateFileTransportInstance;
}

const DailyRotateFile: DailyRotateFileTransportInstance;

export = DailyRotateFile;
}
}

declare class DailyRotateFile extends Transport {
filename: string;
dirname: string;
logStream: NodeJS.WritableStream;
options: DailyRotateFile.DailyRotateFileTransportOptions;
constructor (options?: DailyRotateFile.DailyRotateFileTransportOptions);
}

export = DailyRotateFile;

0 comments on commit dc9404b

Please sign in to comment.