dep 1.0.0 → 1.1.0

package/node_modules/atomically/dist/constants.js

@@ -1,19 +0,0 @@
-/* IMPORT */
-import process from 'node:process';
-/* MAIN */
-const DEFAULT_ENCODING = 'utf8';
-const DEFAULT_FILE_MODE = 0o666;
-const DEFAULT_FOLDER_MODE = 0o777;
-const DEFAULT_READ_OPTIONS = {};
-const DEFAULT_WRITE_OPTIONS = {};
-const DEFAULT_USER_UID = process.geteuid ? process.geteuid() : -1;
-const DEFAULT_USER_GID = process.getegid ? process.getegid() : -1;
-const DEFAULT_INTERVAL_ASYNC = 200;
-const DEFAULT_TIMEOUT_ASYNC = 7500;
-const DEFAULT_TIMEOUT_SYNC = 1000;
-const IS_POSIX = !!process.getuid;
-const IS_USER_ROOT = process.getuid ? !process.getuid() : false;
-const LIMIT_BASENAME_LENGTH = 128; //TODO: Fetch the real limit from the filesystem //TODO: Fetch the whole-path length limit too
-const NOOP = () => { };
-/* EXPORT */
-export { DEFAULT_ENCODING, DEFAULT_FILE_MODE, DEFAULT_FOLDER_MODE, DEFAULT_READ_OPTIONS, DEFAULT_WRITE_OPTIONS, DEFAULT_USER_UID, DEFAULT_USER_GID, DEFAULT_INTERVAL_ASYNC, DEFAULT_TIMEOUT_ASYNC, DEFAULT_TIMEOUT_SYNC, IS_POSIX, IS_USER_ROOT, LIMIT_BASENAME_LENGTH, NOOP };

package/node_modules/atomically/dist/index.d.ts

@@ -1,15 +0,0 @@
-import { Readable } from 'node:stream';
-import type { Callback, Data, Encoding, Path, ReadOptions, WriteOptions } from './types.js';
-declare function readFile(filePath: Path, options: Encoding | ReadOptions & {
-    encoding: string;
-}): Promise<string>;
-declare function readFile(filePath: Path, options?: ReadOptions): Promise<Buffer>;
-declare function readFileSync(filePath: Path, options: Encoding | ReadOptions & {
-    encoding: string;
-}): string;
-declare function readFileSync(filePath: Path, options?: ReadOptions): Buffer;
-declare function writeFile(filePath: Path, data: Data | Readable, callback?: Callback): Promise<void>;
-declare function writeFile(filePath: Path, data: Data | Readable, options?: Encoding | WriteOptions, callback?: Callback): Promise<void>;
-declare function writeFileSync(filePath: Path, data: Data, options?: Encoding | WriteOptions): void;
-export { readFile, readFileSync, writeFile, writeFileSync };
-export type { Encoding, ReadOptions, WriteOptions };

package/node_modules/atomically/dist/index.js

@@ -1,209 +0,0 @@
-/* IMPORT */
-import { once } from 'node:events';
-import { createWriteStream } from 'node:fs';
-import path from 'node:path';
-import { Readable } from 'node:stream';
-import fs from 'stubborn-fs';
-import { DEFAULT_ENCODING, DEFAULT_FILE_MODE, DEFAULT_FOLDER_MODE, DEFAULT_READ_OPTIONS, DEFAULT_WRITE_OPTIONS, DEFAULT_USER_UID, DEFAULT_USER_GID, DEFAULT_INTERVAL_ASYNC, DEFAULT_TIMEOUT_ASYNC, DEFAULT_TIMEOUT_SYNC, IS_POSIX } from './constants.js';
-import { isException, isFunction, isString, isUndefined } from './utils/lang.js';
-import Scheduler from './utils/scheduler.js';
-import Temp from './utils/temp.js';
-function readFile(filePath, options = DEFAULT_READ_OPTIONS) {
-    if (isString(options))
-        return readFile(filePath, { encoding: options });
-    const timeout = options.timeout ?? DEFAULT_TIMEOUT_ASYNC;
-    const retryOptions = { timeout, interval: DEFAULT_INTERVAL_ASYNC };
-    return fs.retry.readFile(retryOptions)(filePath, options);
-}
-function readFileSync(filePath, options = DEFAULT_READ_OPTIONS) {
-    if (isString(options))
-        return readFileSync(filePath, { encoding: options });
-    const timeout = options.timeout ?? DEFAULT_TIMEOUT_SYNC;
-    const retryOptions = { timeout };
-    return fs.retry.readFileSync(retryOptions)(filePath, options);
-}
-function writeFile(filePath, data, options, callback) {
-    if (isFunction(options))
-        return writeFile(filePath, data, DEFAULT_WRITE_OPTIONS, options);
-    const promise = writeFileAsync(filePath, data, options);
-    if (callback)
-        promise.then(callback, callback);
-    return promise;
-}
-async function writeFileAsync(filePath, data, options = DEFAULT_WRITE_OPTIONS) {
-    if (isString(options))
-        return writeFileAsync(filePath, data, { encoding: options });
-    const timeout = options.timeout ?? DEFAULT_TIMEOUT_ASYNC;
-    const retryOptions = { timeout, interval: DEFAULT_INTERVAL_ASYNC };
-    let schedulerCustomDisposer = null;
-    let schedulerDisposer = null;
-    let tempDisposer = null;
-    let tempPath = null;
-    let fd = null;
-    try {
-        if (options.schedule)
-            schedulerCustomDisposer = await options.schedule(filePath);
-        schedulerDisposer = await Scheduler.schedule(filePath);
-        const filePathReal = await fs.attempt.realpath(filePath);
-        const filePathExists = !!filePathReal;
-        filePath = filePathReal || filePath;
-        [tempPath, tempDisposer] = Temp.get(filePath, options.tmpCreate || Temp.create, !(options.tmpPurge === false));
-        const useStatChown = IS_POSIX && isUndefined(options.chown);
-        const useStatMode = isUndefined(options.mode);
-        if (filePathExists && (useStatChown || useStatMode)) {
-            const stats = await fs.attempt.stat(filePath);
-            if (stats) {
-                options = { ...options };
-                if (useStatChown) {
-                    options.chown = { uid: stats.uid, gid: stats.gid };
-                }
-                if (useStatMode) {
-                    options.mode = stats.mode;
-                }
-            }
-        }
-        if (!filePathExists) {
-            const parentPath = path.dirname(filePath);
-            await fs.attempt.mkdir(parentPath, {
-                mode: DEFAULT_FOLDER_MODE,
-                recursive: true
-            });
-        }
-        fd = await fs.retry.open(retryOptions)(tempPath, 'w', options.mode || DEFAULT_FILE_MODE);
-        if (options.tmpCreated) {
-            options.tmpCreated(tempPath);
-        }
-        if (isString(data)) {
-            await fs.retry.write(retryOptions)(fd, data, 0, options.encoding || DEFAULT_ENCODING);
-        }
-        else if (data instanceof Readable) {
-            const writeStream = createWriteStream(tempPath, { fd, autoClose: false });
-            const finishPromise = once(writeStream, 'finish');
-            data.pipe(writeStream);
-            await finishPromise;
-        }
-        else if (!isUndefined(data)) {
-            await fs.retry.write(retryOptions)(fd, data, 0, data.length, 0);
-        }
-        if (options.fsync !== false) {
-            if (options.fsyncWait !== false) {
-                await fs.retry.fsync(retryOptions)(fd);
-            }
-            else {
-                fs.attempt.fsync(fd);
-            }
-        }
-        await fs.retry.close(retryOptions)(fd);
-        fd = null;
-        if (options.chown && (options.chown.uid !== DEFAULT_USER_UID || options.chown.gid !== DEFAULT_USER_GID)) {
-            await fs.attempt.chown(tempPath, options.chown.uid, options.chown.gid);
-        }
-        if (options.mode && options.mode !== DEFAULT_FILE_MODE) {
-            await fs.attempt.chmod(tempPath, options.mode);
-        }
-        try {
-            await fs.retry.rename(retryOptions)(tempPath, filePath);
-        }
-        catch (error) {
-            if (!isException(error))
-                throw error;
-            if (error.code !== 'ENAMETOOLONG')
-                throw error;
-            await fs.retry.rename(retryOptions)(tempPath, Temp.truncate(filePath));
-        }
-        tempDisposer();
-        tempPath = null;
-    }
-    finally {
-        if (fd)
-            await fs.attempt.close(fd);
-        if (tempPath)
-            Temp.purge(tempPath);
-        if (schedulerCustomDisposer)
-            schedulerCustomDisposer();
-        if (schedulerDisposer)
-            schedulerDisposer();
-    }
-}
-function writeFileSync(filePath, data, options = DEFAULT_WRITE_OPTIONS) {
-    if (isString(options))
-        return writeFileSync(filePath, data, { encoding: options });
-    const timeout = options.timeout ?? DEFAULT_TIMEOUT_SYNC;
-    const retryOptions = { timeout };
-    let tempDisposer = null;
-    let tempPath = null;
-    let fd = null;
-    try {
-        const filePathReal = fs.attempt.realpathSync(filePath);
-        const filePathExists = !!filePathReal;
-        filePath = filePathReal || filePath;
-        [tempPath, tempDisposer] = Temp.get(filePath, options.tmpCreate || Temp.create, !(options.tmpPurge === false));
-        const useStatChown = IS_POSIX && isUndefined(options.chown);
-        const useStatMode = isUndefined(options.mode);
-        if (filePathExists && (useStatChown || useStatMode)) {
-            const stats = fs.attempt.statSync(filePath);
-            if (stats) {
-                options = { ...options };
-                if (useStatChown) {
-                    options.chown = { uid: stats.uid, gid: stats.gid };
-                }
-                if (useStatMode) {
-                    options.mode = stats.mode;
-                }
-            }
-        }
-        if (!filePathExists) {
-            const parentPath = path.dirname(filePath);
-            fs.attempt.mkdirSync(parentPath, {
-                mode: DEFAULT_FOLDER_MODE,
-                recursive: true
-            });
-        }
-        fd = fs.retry.openSync(retryOptions)(tempPath, 'w', options.mode || DEFAULT_FILE_MODE);
-        if (options.tmpCreated) {
-            options.tmpCreated(tempPath);
-        }
-        if (isString(data)) {
-            fs.retry.writeSync(retryOptions)(fd, data, 0, options.encoding || DEFAULT_ENCODING);
-        }
-        else if (!isUndefined(data)) {
-            fs.retry.writeSync(retryOptions)(fd, data, 0, data.length, 0);
-        }
-        if (options.fsync !== false) {
-            if (options.fsyncWait !== false) {
-                fs.retry.fsyncSync(retryOptions)(fd);
-            }
-            else {
-                fs.attempt.fsync(fd);
-            }
-        }
-        fs.retry.closeSync(retryOptions)(fd);
-        fd = null;
-        if (options.chown && (options.chown.uid !== DEFAULT_USER_UID || options.chown.gid !== DEFAULT_USER_GID)) {
-            fs.attempt.chownSync(tempPath, options.chown.uid, options.chown.gid);
-        }
-        if (options.mode && options.mode !== DEFAULT_FILE_MODE) {
-            fs.attempt.chmodSync(tempPath, options.mode);
-        }
-        try {
-            fs.retry.renameSync(retryOptions)(tempPath, filePath);
-        }
-        catch (error) {
-            if (!isException(error))
-                throw error;
-            if (error.code !== 'ENAMETOOLONG')
-                throw error;
-            fs.retry.renameSync(retryOptions)(tempPath, Temp.truncate(filePath));
-        }
-        tempDisposer();
-        tempPath = null;
-    }
-    finally {
-        if (fd)
-            fs.attempt.closeSync(fd);
-        if (tempPath)
-            Temp.purge(tempPath);
-    }
-}
-/* EXPORT */
-export { readFile, readFileSync, writeFile, writeFileSync };

package/node_modules/atomically/dist/types.d.ts

@@ -1,27 +0,0 @@
-type Callback = (error: Exception | void) => void;
-type Data = Uint8Array | string | undefined;
-type Disposer = () => void;
-type Encoding = 'ascii' | 'base64' | 'binary' | 'hex' | 'latin1' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2';
-type Exception = NodeJS.ErrnoException;
-type Path = string;
-type ReadOptions = {
-    encoding?: Encoding | null;
-    mode?: string | number | false;
-    timeout?: number;
-};
-type WriteOptions = {
-    chown?: {
-        gid: number;
-        uid: number;
-    } | false;
-    encoding?: Encoding | null;
-    fsync?: boolean;
-    fsyncWait?: boolean;
-    mode?: string | number | false;
-    schedule?: (filePath: string) => Promise<Disposer>;
-    timeout?: number;
-    tmpCreate?: (filePath: string) => string;
-    tmpCreated?: (filePath: string) => void;
-    tmpPurge?: boolean;
-};
-export type { Callback, Data, Disposer, Encoding, Exception, Path, ReadOptions, WriteOptions };

package/node_modules/atomically/dist/types.js

@@ -1,2 +0,0 @@
-/* MAIN */
-export {};

package/node_modules/atomically/dist/utils/lang.d.ts

@@ -1,6 +0,0 @@
-import type { Exception } from '../types.js';
-declare const isException: (value: unknown) => value is Exception;
-declare const isFunction: (value: unknown) => value is Function;
-declare const isString: (value: unknown) => value is string;
-declare const isUndefined: (value: unknown) => value is undefined;
-export { isException, isFunction, isString, isUndefined };

package/node_modules/atomically/dist/utils/lang.js

@@ -1,16 +0,0 @@
-/* IMPORT */
-/* MAIN */
-const isException = (value) => {
-    return (value instanceof Error) && ('code' in value);
-};
-const isFunction = (value) => {
-    return (typeof value === 'function');
-};
-const isString = (value) => {
-    return (typeof value === 'string');
-};
-const isUndefined = (value) => {
-    return (value === undefined);
-};
-/* EXPORT */
-export { isException, isFunction, isString, isUndefined };

package/node_modules/atomically/dist/utils/scheduler.d.ts

@@ -1,6 +0,0 @@
-import type { Disposer } from '../types.js';
-declare const Scheduler: {
-    next: (id: string) => void;
-    schedule: (id: string) => Promise<Disposer>;
-};
-export default Scheduler;

package/node_modules/atomically/dist/utils/scheduler.js

@@ -1,34 +0,0 @@
-/* IMPORT */
-/* HELPERS */
-const Queues = {};
-/* MAIN */
-//TODO: Maybe publish this as a standalone package
-const Scheduler = {
-    /* API */
-    next: (id) => {
-        const queue = Queues[id];
-        if (!queue)
-            return;
-        queue.shift();
-        const job = queue[0];
-        if (job) {
-            job(() => Scheduler.next(id));
-        }
-        else {
-            delete Queues[id];
-        }
-    },
-    schedule: (id) => {
-        return new Promise(resolve => {
-            let queue = Queues[id];
-            if (!queue)
-                queue = Queues[id] = [];
-            queue.push(resolve);
-            if (queue.length > 1)
-                return;
-            resolve(() => Scheduler.next(id));
-        });
-    }
-};
-/* EXPORT */
-export default Scheduler;

package/node_modules/atomically/dist/utils/temp.d.ts

@@ -1,11 +0,0 @@
-import type { Disposer } from '../types.js';
-declare const Temp: {
-    store: Record<string, boolean>;
-    create: (filePath: string) => string;
-    get: (filePath: string, creator: (filePath: string) => string, purge?: boolean) => [string, Disposer];
-    purge: (filePath: string) => void;
-    purgeSync: (filePath: string) => void;
-    purgeSyncAll: () => void;
-    truncate: (filePath: string) => string;
-};
-export default Temp;

package/node_modules/atomically/dist/utils/temp.js

@@ -1,59 +0,0 @@
-/* IMPORT */
-import path from 'node:path';
-import fs from 'stubborn-fs';
-import whenExit from 'when-exit';
-import { LIMIT_BASENAME_LENGTH } from '../constants.js';
-/* MAIN */
-//TODO: Maybe publish this as a standalone package
-const Temp = {
-    /* VARIABLES */
-    store: {}, // filePath => purge
-    /* API */
-    create: (filePath) => {
-        const randomness = `000000${Math.floor(Math.random() * 16777215).toString(16)}`.slice(-6); // 6 random-enough hex characters
-        const timestamp = Date.now().toString().slice(-10); // 10 precise timestamp digits
-        const prefix = 'tmp-';
-        const suffix = `.${prefix}${timestamp}${randomness}`;
-        const tempPath = `${filePath}${suffix}`;
-        return tempPath;
-    },
-    get: (filePath, creator, purge = true) => {
-        const tempPath = Temp.truncate(creator(filePath));
-        if (tempPath in Temp.store)
-            return Temp.get(filePath, creator, purge); // Collision found, try again
-        Temp.store[tempPath] = purge;
-        const disposer = () => delete Temp.store[tempPath];
-        return [tempPath, disposer];
-    },
-    purge: (filePath) => {
-        if (!Temp.store[filePath])
-            return;
-        delete Temp.store[filePath];
-        fs.attempt.unlink(filePath);
-    },
-    purgeSync: (filePath) => {
-        if (!Temp.store[filePath])
-            return;
-        delete Temp.store[filePath];
-        fs.attempt.unlinkSync(filePath);
-    },
-    purgeSyncAll: () => {
-        for (const filePath in Temp.store) {
-            Temp.purgeSync(filePath);
-        }
-    },
-    truncate: (filePath) => {
-        const basename = path.basename(filePath);
-        if (basename.length <= LIMIT_BASENAME_LENGTH)
-            return filePath; //FIXME: Rough and quick attempt at detecting ok lengths
-        const truncable = /^(\.?)(.*?)((?:\.[^.]+)?(?:\.tmp-\d{10}[a-f0-9]{6})?)$/.exec(basename);
-        if (!truncable)
-            return filePath; //FIXME: No truncable part detected, can't really do much without also changing the parent path, which is unsafe, hoping for the best here
-        const truncationLength = basename.length - LIMIT_BASENAME_LENGTH;
-        return `${filePath.slice(0, -basename.length)}${truncable[1]}${truncable[2].slice(0, -truncationLength)}${truncable[3]}`; //FIXME: The truncable part might be shorter than needed here
-    }
-};
-/* INIT */
-whenExit(Temp.purgeSyncAll); // Ensuring purgeable temp files are purged on exit
-/* EXPORT */
-export default Temp;

package/node_modules/atomically/license

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020-present Fabio Spampinato
-
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the "Software"),
-to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.

package/node_modules/atomically/package.json

@@ -1,42 +0,0 @@
-{
-  "name": "atomically",
-  "repository": "github:fabiospampinato/atomically",
-  "description": "Read and write files atomically and reliably.",
-  "license": "MIT",
-  "version": "2.1.1",
-  "type": "module",
-  "main": "dist/index.js",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "benchmark": "tsex benchmark",
-    "benchmarkLwatch": "tsex benchmark --watch",
-    "clean": "tsex clean",
-    "compile": "tsex compile",
-    "compile:watch": "tsex compile --watch",
-    "test:init": "esbuild --bundle --log-level=error --target=es2020 --platform=node --format=cjs src/index.ts > test/atomically.cjs",
-    "test": "npm run test:init && tap --disable-coverage",
-    "test:watch": "npm run test:init && tap --disable-coverage --watch",
-    "prepublishOnly": "npm run clean && npm run compile && npm run test"
-  },
-  "keywords": [
-    "atomic",
-    "read",
-    "write",
-    "file",
-    "reliable"
-  ],
-  "dependencies": {
-    "stubborn-fs": "^2.0.0",
-    "when-exit": "^2.1.4"
-  },
-  "devDependencies": {
-    "@types/node": "^18.19.130",
-    "esbuild": "^0.18.20",
-    "require-inject": "^1.4.4",
-    "tap": "^21.1.1",
-    "tsex": "^4.0.2",
-    "typescript": "^5.9.3",
-    "write-file-atomic": "^7.0.0"
-  }
-}

package/node_modules/atomically/readme.md

@@ -1,147 +0,0 @@
-# Atomically
-
-Read and write files atomically and reliably.
-
-## Features
-
-- Overview:
-  - This library is a rewrite of [`write-file-atomic`](https://github.com/npm/write-file-atomic), with some important enhancements on top, you can largely use this as a drop-in replacement.
-  - This library is written in TypeScript, so types aren't an afterthought but come with library.
-  - This library is slightly faster than [`write-file-atomic`](https://github.com/npm/write-file-atomic), and it can be 10x faster, while being essentially just as safe, by using the `fsyncWait` option.
-  - This library has 0 third-party dependencies, so there's less code to vet and the entire thing is roughly 20% smaller than [`write-file-atomic`](https://github.com/npm/write-file-atomic).
-  - This library tries harder to write files on disk than [`write-file-atomic`](https://github.com/npm/write-file-atomic) does, by default retrying some failed operations and handling some more errors.
-- Reliability:
-  - Reads are retried, when appropriate, until they succeed or the timeout is reached.
-  - Writes are atomic, meaning that first a temporary file containing the new content is written, then this file is renamed to the final path, this way it's impossible to get a corrupt/partially-written file.
-  - Writes happening to the same path are queued, ensuring they don't interfere with each other.
-  - Temporary files can be configured to not be purged from disk if the write operation fails, which is useful for when keeping the temporary file is better than just losing data.
-  - Any needed missing parent folder will be created automatically.
-  - Symlinks are resolved automatically.
-  - `ENOSYS` errors on `chmod`/`chown` operations are ignored.
-  - `EINVAL`/`EPERM` errors on `chmod`/`chown` operations, in POSIX systems where the user is not root, are ignored.
-  - `EMFILE`/`ENFILE`/`EAGAIN`/`EBUSY`/`EACCESS`/`EACCES`/`EACCS`/`EPERM` errors happening during necessary operations are caught and the operations are retried until they succeed or the timeout is reached.
-  - `ENAMETOOLONG` errors, both appening because of the final path or the temporary path, are attempted to be worked around by smartly truncating paths.
-- Temporary files:
-  - By default they are purged automatically once the write operation is completed or if the process exits (cleanly or not).
-  - By default they are created by appending a `.tmp-[timestamp][randomness]` suffix to destination paths:
-    - The `tmp-` part gives users a hint about the nature of these files, if they happen to see them.
-    - The `[timestamp]` part consists of the 10 least significant digits of a milliseconds-precise timestamp, making it likely that if more than one of these files are kept on disk the user will see them in chronological order.
-    - The `[randomness]` part consists of 6 random hex characters.
-    - If by any chance a collision is found then another suffix is generated.
-- Custom options:
-  - `chown`: it allows you to specify custom group and user ids:
-    - by default the old file's ids are copied over.
-    - if custom ids are provided they will be used.
-    - if `false` the default ids are used.
-  - `encoding`: it allows you to specify the encoding of the file content:
-    - by default when reading no encoding is specified and a raw buffer is returned.
-    - by default when writing `utf8` is used when.
-  - `fsync`: it allows you to control whether the `fsync` syscall is triggered right after writing the file or not:
-    - by default the syscall is triggered immediately after writing the file, increasing the chances that the file will actually be written to disk in case of imminent catastrophic failures, like power outages.
-    - if `false` the syscall won't be triggered.
-  - `fsyncWait`: it allows you to control whether the triggered `fsync` is waited or not:
-    - by default the syscall is waited.
-    - if `false` the syscall will still be triggered but not be waited.
-      - this increases performance 10x in some cases, and at the end of the day often there's no plan B if `fsync` fails anyway.
-  - `mode`: it allows you to specify the mode for the file:
-    - by default the old file's mode is copied over.
-    - if `false` then `0o666` is used.
-  - `schedule`: it's a function that returns a promise that resolves to a disposer function, basically it allows you to provide some custom queueing logic for the writing operation, allowing you to perhaps wire `atomically` with your app's main filesystem job scheduler:
-    - even when a custom `schedule` function is provided write operations will still be queued internally by the library too.
-  - `timeout`: it allows you to specify the amount of maximum milliseconds within which the library will retry some failed operations:
-    - when writing asynchronously by default it will keep retrying for 7500 milliseconds.
-    - when writing synchronously by default it will keep retrying for 1000 milliseconds.
-    - if `0` or `-1` no failed operations will be retried.
-    - if another number is provided that will be the timeout interval.
-  - `tmpCreate`: it's a function that will be used to create the custom temporary file path in place of the default one:
-    - even when a custom function is provided the final temporary path will still be truncated if the library thinks that it may lead to `ENAMETOOLONG` errors.
-    - paths by default are truncated in a way that preserves an eventual existing leading dot and trailing extension.
-  - `tmpCreated`: it's a function that will be called with the newly created temporary file path.
-  - `tmpPurge`: it allows you to control whether the temporary file will be purged from the filesystem or not if the write fails:
-    - by default it will be purged.
-    - if `false` it will be kept on disk.
-
-## Install
-
-```sh
-npm install atomically
-```
-
-## Usage
-
-This is the shape of the optional options object:
-
-```ts
-type Disposer = () => void;
-
-type ReadOptions = string | {
-  encoding?: string | null,
-  mode?: string | number | false,
-  timeout?: number
-};
-
-type WriteOptions = string | {
-  chown?: { gid: number, uid: number } | false,
-  encoding?: string | null,
-  fsync?: boolean,
-  fsyncWait?: boolean,
-  mode?: string | number | false,
-  schedule?: ( filePath: string ) => Promise<Disposer>,
-  timeout?: number,
-  tmpCreate?: ( filePath: string ) => string,
-  tmpCreated?: ( filePath: string ) => any,
-  tmpPurge?: boolean
-};
-```
-
-This is the shape of the provided functions:
-
-```ts
-function readFile ( filePath: string, options?: ReadOptions ): Promise<Buffer | string>;
-function readFileSync ( filePath: string, options?: ReadOptions ): Buffer | string;
-function writeFile ( filePath: string, data: Readable | Buffer | string | undefined, options?: WriteOptions ): Promise<void>;
-function writeFileSync ( filePath: string, data: Buffer | string | undefined, options?: WriteOptions ): void;
-```
-
-This is how to use the library:
-
-```ts
-import {readFile, readFileSync, writeFile, writeFileSync} from 'atomically';
-
-// Asynchronous read with default option
-const buffer = await readFile ( '/foo.txt' );
-
-// Synchronous read assuming the encoding is "utf8"
-const string = readFileSync ( '/foo.txt', 'utf8' );
-
-// Asynchronous write with default options
-await writeFile ( '/foo.txt', 'my_data' );
-
-// Asynchronous write that doesn't prod the old file for a stat object at all
-await writeFile ( '/foo.txt', 'my_data', { chown: false, mode: false } );
-
-// 10x faster asynchronous write that's less resilient against imminent catastrophies
-await writeFile ( '/foo.txt', 'my_data', { fsync: false } );
-
-// 10x faster asynchronous write that's essentially still as resilient against imminent catastrophies
-await writeFile ( '/foo.txt', 'my_data', { fsyncWait: false } );
-
-// Asynchronous write with a custom schedule function
-await writeFile ( '/foo.txt', 'my_data', {
-  schedule: filePath => {
-    return new Promise ( resolve => { // When this returned promise will resolve the write operation will begin
-      MyScheduler.schedule ( filePath, () => { // Hypothetical scheduler function that will eventually tell us to go on with this write operation
-        const disposer = () => {}; // Hypothetical function that contains eventual clean-up logic, it will be called after the write operation has been completed (successfully or not)
-        resolve ( disposer ); // Resolving the promise with a disposer, beginning the write operation
-      })
-    });
-  }
-});
-
-// Synchronous write with default options
-writeFileSync ( '/foo.txt', 'my_data' );
-```
-
-## License
-
-MIT © Fabio Spampinato