@logtape/file/dist/filesink.node.js

File sink and rotating file sink for LogTape

import { getBaseFileSink, getBaseRotatingFileSink } from "./filesink.base.js";
import fs from "node:fs";

//#region filesink.node.ts
/**
* A Node.js-specific file sink driver.
*/
const nodeDriver = {
	openSync(path) {
		return fs.openSync(path, "a");
	},
	writeSync: fs.writeSync,
	flushSync: fs.fsyncSync,
	closeSync: fs.closeSync,
	statSync: fs.statSync,
	renameSync: fs.renameSync
};
/**
* 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.
*/
function getFileSink(path, options = {}) {
	return getBaseFileSink(path, {
		...options,
		...nodeDriver
	});
}
/**
* 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.
*/
function getRotatingFileSink(path, options = {}) {
	return getBaseRotatingFileSink(path, {
		...options,
		...nodeDriver
	});
}

//#endregion
export { getFileSink, getRotatingFileSink, nodeDriver };
//# sourceMappingURL=filesink.node.js.map