logroller 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+import { Writable } from "node:stream";
+export type RotationReason = "time" | "size" | "manual";
+export interface RotateFileStreamOptions {
+    /** Required. Must contain %DATE% — e.g. "logs/app-%DATE%.log" */
+    filename: string;
+    /** Tokens: YYYY YY MM DD HH mm ss. Default "YYYY-MM-DD". */
+    datePattern?: string;
+    /** gzip closed segments. Default false. */
+    zippedArchive?: boolean;
+    /** Roll when next write would exceed: 20 | "20m" | "1k" | "5g". 0/undefined = off. */
+    maxSize?: number | string;
+    /** Retention: "90d" (age) | 500 (count). Unset = never delete. */
+    maxFiles?: number | string;
+    /** Any IANA zone. Default "UTC". */
+    tz?: string;
+    /** "daily" | "1s" | "5m" | "2h" | ms number. Default "daily". */
+    frequency?: number | string;
+    /** Static virtual-clock shift in hours ("-6h", 1.5). TEST ONLY. */
+    addHours?: number | string;
+    /** Amount added to the clock every clockStepIntervalMs ("24h"). TEST ONLY. */
+    addHoursEveryMin?: number | string;
+    /** How often addHoursEveryMin applies. Default 60_000 ms. */
+    clockStepIntervalMs?: number;
+    /** Don't hold the process open via rotation timers. */
+    unrefTimers?: boolean;
+    /** Write <stem>_audit.json manifest. Default true. */
+    audit?: boolean;
+    /** Override manifest filename. */
+    auditFile?: string;
+    highWaterMark?: number;
+}
+export interface RotatedInfo {
+    reason: RotationReason;
+    oldFile: string | null;
+    archive: string | null;
+    newFile: string;
+}
+export interface ClockInfo {
+    addHours?: number | string;
+    addHoursEveryMin?: number | string;
+    offsetMs: number;
+}
+export interface RotateFileStreamEvents {
+    open: (file: string) => void;
+    rotated: (info: RotatedInfo) => void;
+    archive: (gzFile: string) => void;
+    deleted: (file: string) => void;
+    period: (stamp: string) => void;
+    clock: (info: ClockInfo) => void;
+    warn: (err: Error) => void;
+    error: (err: Error) => void;
+    close: () => void;
+}
+/** ◀ TS FIX: interface members SHADOW inherited Writable.on/emit.
+ *  Add a generic string fallback so `.pipe()` stays structurally valid. */
+export interface RotateFileStream {
+    on<E extends keyof RotateFileStreamEvents>(event: E, listener: RotateFileStreamEvents[E]): this;
+    on(event: string, listener: (...args: any[]) => void): this;
+    once<E extends keyof RotateFileStreamEvents>(event: E, listener: RotateFileStreamEvents[E]): this;
+    once(event: string, listener: (...args: any[]) => void): this;
+    emit<E extends keyof RotateFileStreamEvents>(event: E, ...args: Parameters<RotateFileStreamEvents[E]>): boolean;
+    emit(event: string, ...args: any[]): boolean;
+}
+interface ParsedMaxFiles {
+    days?: number;
+    count?: number;
+}
+type ParsedFrequency = {
+    type: "daily";
+} | {
+    type: "interval";
+    ms: number;
+};
+export declare class RotateFileStream extends Writable {
+    readonly tz: string;
+    readonly template: string;
+    readonly dir: string;
+    readonly datePattern: string;
+    readonly zippedArchive: boolean;
+    readonly maxSize: number;
+    readonly maxFiles: ParsedMaxFiles | null;
+    readonly freq: ParsedFrequency;
+    readonly unrefTimers: boolean;
+    private readonly _tL;
+    private readonly _tMid;
+    private readonly _tExt;
+    private readonly _rxFor;
+    private readonly _rxActive;
+    private readonly _auditEnabled;
+    private readonly _auditPath;
+    private readonly _bootId;
+    private _offsetMs;
+    private _stepMs;
+    private _bumpEvery;
+    private _curStamp;
+    private _index;
+    private _ws;
+    private _path;
+    private _bytes;
+    private _timer;
+    private _bumpTimer;
+    private _ended;
+    private _tail;
+    private _audit;
+    constructor(opts?: Partial<RotateFileStreamOptions>);
+    get filename(): string | null;
+    get currentIndex(): number;
+    private _now;
+    rotateNow(): Promise<void>;
+    /** Apply one virtual-clock step immediately (test helper). */
+    advanceClock(): Promise<void>;
+    private _resetAuditObject;
+    private _loadAudit;
+    private _saveAudit;
+    private _pruneAuditFiles;
+    private _aevent;
+    private _setActivePointer;
+    private _demoteZombieActives;
+    private _reconcileWithDisk;
+    private _repairInterruptedGzips;
+    private _finishArchivedRecord;
+    _write(chunk: any, encoding: BufferEncoding, cb: (error?: Error | null) => void): void;
+    _final(cb: (error?: Error | null) => void): void;
+    destroy(...args: Parameters<Writable["destroy"]>): this;
+    private _job;
+    private _stampNow;
+    private _resolveName;
+    private _recoverIndexFor;
+    private _ensureOpen;
+    private _rotate;
+    private _hasContent;
+    private _armTimer;
+    private _armBump;
+    private _stopBump;
+    private _applyBump;
+    private _stopTimer;
+    private _retire;
+}
+export declare function createStream(options: RotateFileStreamOptions): RotateFileStream;
+export {};