file-writer

Description

file-writer provides methods for easy fire-and-forget file operations.

It prevents race conditions on multiple write operations for the same filename. It schedules a write operation, if it is requested before the previous one has finished.

Installation

npm install "@popovmp/file-writer"

Usage

import {appendAndForget, writeAndForget} from "@popovmp/file-writer";

writeAndForget("example.txt", "Some text\n");
appendAndForget("example.txt", "Another text\n");

It safely writes the following content to example.txt:

import {appendAndForget} from "@popovmp/file-writer";

for (let i = 0; i < 1000; i++) {
    appendAndForget("example.txt", `Line ${i}\n`);
}

Error handling

The lib logs the errors to the console by default. However, we can provide a custom error handler.

import { errorHandler, writeAndForget } from "@popovmp/file-writer";

function errorHandler(err, filepath, stage) {
    console.error(`[file-writer] ${stage} error for ${filepath}:`, err);
}

setErrorHandler(errorHandler);
writeAndForget("hello.txt", "Hello, World!\n");

Chekc is busy

file-writer provides functionality to check if there are ongoing operations.

import { writeAndForget, isWriterBusy } from "@popovmp/file-writer";

writeAndForget("hello.txt", "Hello, World!\n");
console.log( isWriterBusy() ); // => true

setTimeout(() => {
    console.log( isWriterBusy() ); // => false
}, 100);