redefine type declaration and inject into winston.transports

Author: Matt Berther

Diff for: index.d.ts

@@ -1,83 +1,106 @@
-declare module "winston-daily-rotate-file" {
-  import * as Transport from "winston-transport";
-
-  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;
-
-          /**
-           * A string representing the name of the name of the audit file. (default: './hash-audit.json')
-           */
-          auditFile?: string;
-
-          /**
-           * A string representing the frequency of rotation. (default: 'custom')
-           */
-          frequency?: string;
-
-          /**
-           * A boolean whether or not to generate file name from "datePattern" in UTC format. (default: false)
-           */
-          utc?: boolean;
-
-          /**
-           * A string representing an extension to be added to the filename, if not included in the filename property. (default: '')
-           */
-          extension?: string;
-      }
-  }
-
-  interface DailyRotateFileTransportInstance extends Transport {
-      filename: string;
-      dirname: string;
-      logStream: NodeJS.WritableStream;
-      options: DailyRotateFile.DailyRotateFileTransportOptions;
-
-      new (options?: DailyRotateFile.DailyRotateFileTransportOptions): DailyRotateFileTransportInstance;
-  }
-
-  const DailyRotateFile: DailyRotateFileTransportInstance;
-
-  export = DailyRotateFile;
+import TransportStream from "winston-transport";
+
+// referenced from https://stackoverflow.com/questions/40510611/typescript-interface-require-one-of-two-properties-to-exist
+type RequireOnlyOne<T, Keys extends keyof T = keyof T> =
+    Pick<T, Exclude<keyof T, Keys>>
+    & {
+        [K in Keys]-?:
+            Required<Pick<T, K>>
+            & Partial<Record<Exclude<Keys, K>, undefined>>
+    }[Keys];
+
+// merging into winston.transports
+declare module 'winston/lib/winston/transports' {
+    interface Transports {
+        DailyRotateFileTransport: typeof DailyRotateFileTransport;
+        DailyRotateFileTransportOptions: DailyRotateFileTransportOptions;
+    }
 }
+
+export type DailyRotateFileTransportOptions = RequireOnlyOne<GeneralDailyRotateFileTransportOptions, 'filename' | 'stream'>;
+
+interface GeneralDailyRotateFileTransportOptions extends TransportStream.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;
+
+    /**
+     * A string representing the name of the name of the audit file. (default: './hash-audit.json')
+     */
+    auditFile?: string;
+
+    /**
+     * A string representing the frequency of rotation. (default: 'custom')
+     */
+    frequency?: string;
+
+    /**
+     * A boolean whether or not to generate file name from "datePattern" in UTC format. (default: false)
+     */
+    utc?: boolean;
+
+    /**
+     * A string representing an extension to be added to the filename, if not included in the filename property. (default: '')
+     */
+    extension?: string;
+
+    /**
+      * Create a tailable symlink to the current active log file. (default: false)
+      */
+    createSymlink?: boolean;
+
+    /**
+      * The name of the tailable symlink. (default: 'current.log')
+      */
+    symlinkName?: string;
+}
+
+declare class DailyRotateFileTransport extends TransportStream {
+    filename: string;
+    dirname: string;
+    logStream: NodeJS.WritableStream;
+    options: DailyRotateFileTransportOptions;
+
+    constructor(options: DailyRotateFileTransportOptions);
+}
+
+export default DailyRotateFileTransport;