@logtape/file/dist/filesink.node.d.ts

File sink and rotating file sink for LogTape

import { FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions } from "./filesink.base.js";
import { Sink } from "@logtape/logtape";

//#region filesink.node.d.ts

/**
 * A Node.js-specific file sink driver.
 */
declare const nodeDriver: RotatingFileSinkDriver<number | void>;
/**
 * Get a file sink.
 *
 * Note that this function is unavailable in the browser.
 *
 * @param path A path to the file to write to.
 * @param options The options for the sink.
 * @returns A sink that writes to the file.  The sink is also a disposable
 *          object that closes the file when disposed.
 */
declare function getFileSink(path: string, options?: FileSinkOptions): Sink & Disposable;
/**
 * Get a rotating file sink.
 *
 * This sink writes log records to a file, and rotates the file when it reaches
 * the `maxSize`.  The rotated files are named with the original file name
 * followed by a dot and a number, starting from 1.  The number is incremented
 * for each rotation, and the maximum number of files to keep is `maxFiles`.
 *
 * Note that this function is unavailable in the browser.
 *
 * @param path A path to the file to write to.
 * @param options The options for the sink and the file driver.
 * @returns A sink that writes to the file.  The sink is also a disposable
 *          object that closes the file when disposed.
 */
declare function getRotatingFileSink(path: string, options?: RotatingFileSinkOptions): Sink & Disposable;
//# sourceMappingURL=filesink.node.d.ts.map
//#endregion
export { getFileSink, getRotatingFileSink, nodeDriver };
//# sourceMappingURL=filesink.node.d.ts.map