@visulima/fs 5.0.0-alpha.7 → 5.0.0-alpha.9

package/dist/move/index.d.ts

@@ -1,68 +0,0 @@
-/**
- * Modified functions from https://github.com/sindresorhus/move-file
- *
- * The original functions are licensed under the MIT License:
- *
- * MIT License
- *
- * Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
- */
-import type { Options } from './types.d.ts';
-/**
- * Move a file asynchronously.
- * @param sourcePath The file you want to move.
- * @param destinationPath Where you want the file moved.
- * @param options Configuration options.
- * @returns A `Promise` that resolves when the file has been moved.
- * @example
- * ```
- * import { move } from '@visulima/fs';
- *
- * await move('source/test.png', 'destination/test.png');
- * console.log('The file has been moved');
- * ```
- */
-export declare const move: (sourcePath: string, destinationPath: string, options?: Options) => Promise<void>;
-/**
- * Move a file synchronously.
- * @param sourcePath The file you want to move.
- * @param destinationPath Where you want the file moved.
- * @param options Configuration options.
- * @example
- * ```
- * import { moveSync } from '@visulima/fs';
- *
- * moveSync('source/test.png', 'destination/test.png');
- * console.log('The file has been moved');
- * ```
- */
-export declare const moveSync: (sourcePath: string, destinationPath: string, options?: Options) => void;
-/**
- * Rename a file asynchronously.
- * @param source The file you want to rename.
- * @param destination The name of the renamed file.
- * @param options Configuration options.
- * @returns A `Promise` that resolves when the file has been renamed.
- * @example
- * ```
- * import { rename } from '@visulima/fs';
- *
- * await rename('test.png', 'tests.png', {cwd: 'source'});
- * console.log('The file has been renamed');
- * ```
- */
-export declare const rename: (source: string, destination: string, options?: Options) => Promise<void>;
-/**
- * Rename a file synchronously.
- * @param source The file you want to rename.
- * @param destination The name of the renamed file.
- * @param options Configuration options.
- * @example
- * ```
- * import { renameSync } from '@visulima/fs';
- *
- * renameSync('test.png', 'tests.png', {cwd: 'source'});
- * console.log('The file has been renamed');
- * ```
- */
-export declare const renameSync: (source: string, destination: string, options?: Options) => void;

package/dist/move/types.d.ts

@@ -1,36 +0,0 @@
-export type Options = {
-    /**
-     * The working directory to find source files.
-     * The source and destination path are relative to this.
-     * @default process.cwd()
-     */
-    cwd?: URL | string;
-    /**
-     * [Permissions](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) for created directories.
-     *
-     * It has no effect on Windows.
-     * @default 0o777
-     */
-    readonly directoryMode?: number;
-    /**
-     * Overwrite existing destination file.
-     * @default true
-     */
-    readonly overwrite?: boolean;
-};
-/**
- * Internal options used by the move/rename implementation.
- * Extends the public Options type with additional internal properties.
- */
-export type InternalOptions = Options & {
-    /**
-     * Resolved working directory path.
-     * URLs from the Options type are converted to string paths.
-     */
-    cwd: string;
-    /**
-     * Whether to validate the directory structure before operation.
-     * @internal
-     */
-    validateDirectory?: boolean;
-};

package/dist/move/utils/internal-move-file-sync.d.ts

@@ -1,3 +0,0 @@
-import type { InternalOptions } from "../types.d.ts";
-declare const internalMoveFileSync: (sourcePath: string, destinationPath: string, { cwd, directoryMode, overwrite, validateDirectory }: InternalOptions) => void;
-export default internalMoveFileSync;

package/dist/move/utils/internal-move-file.d.ts

@@ -1,3 +0,0 @@
-import type { InternalOptions } from "../types.d.ts";
-declare const internalMoveFile: (sourcePath: string, destinationPath: string, { cwd, directoryMode, overwrite, validateDirectory }: InternalOptions) => Promise<void>;
-export default internalMoveFile;

package/dist/move/utils/validate-same-directory.d.ts

@@ -1,2 +0,0 @@
-declare const validateSameDirectory: (source: string, destination: string) => void;
-export default validateSameDirectory;

package/dist/read/read-file-sync.d.ts

@@ -1,37 +0,0 @@
-import type { ContentType, ReadFileOptions } from "../types.d.ts";
-type DecompressionMethod = (buffer: Buffer) => Buffer;
-declare const decompressionMethods: Record<string, DecompressionMethod>;
-/**
- * Synchronously reads the entire contents of a file.
- * It can also decompress the file content if a `compression` option is provided.
- * @template O - The type of the options object, extending {@link ReadFileOptions}.
- * @param path The path to the file to read. Can be a file URL or a string path.
- * @param options Optional configuration for reading the file. See {@link ReadFileOptions}.
- * Available `compression` methods: "brotli", "gzip", "none" (default).
- * @returns The file content. The type of the content (string or Buffer)
- * depends on the `buffer` option (defaults to string if `buffer` is false or not set).
- * @example
- * ```javascript
- * import { readFileSync } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * try {
- *   // Read a regular text file
- *   const content = readFileSync(join("path", "to", "my-file.txt"));
- *   console.log("File content:", content);
- *
- *   // Read a file as a Buffer
- *   const bufferContent = readFileSync(join("path", "to", "another-file.bin"), { buffer: true });
- *   console.log("Buffer length:", bufferContent.length);
- *
- *   // Read and decompress a gzipped file
- *   // Assume my-archive.txt.gz exists
- *   // const decompressedContent = readFileSync(join("path", "to", "my-archive.txt.gz"), { compression: "gzip", encoding: "utf8" });
- *   // console.log("Decompressed content:", decompressedContent);
- * } catch (error) {
- *   console.error("Failed to read file:", error);
- * }
- * ```
- */
-declare const readFileSync: <O extends ReadFileOptions<keyof typeof decompressionMethods> | undefined = undefined>(path: URL | string, options?: O) => ContentType<O>;
-export default readFileSync;

package/dist/read/read-file.d.ts

@@ -1,41 +0,0 @@
-import type { ContentType, ReadFileOptions } from "../types.d.ts";
-type DecompressionMethod = (buffer: Buffer, callback: (error: Error | null, result: Buffer) => void) => void;
-declare const decompressionMethods: Record<string, DecompressionMethod>;
-/**
- * Asynchronously reads the entire contents of a file.
- * It can also decompress the file content if a `compression` option is provided.
- * @template O - The type of the options object, extending {@link ReadFileOptions}.
- * @param path The path to the file to read. Can be a file URL or a string path.
- * @param options Optional configuration for reading the file. See {@link ReadFileOptions}.
- * Available `compression` methods: "brotli", "gzip", "none" (default).
- * @returns A promise that resolves with the file content. The type of the content (string or Buffer)
- * depends on the `buffer` option (defaults to string if `buffer` is false or not set).
- * @example
- * ```javascript
- * import { readFile } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const readMyFile = async () => {
- *   try {
- *     // Read a regular text file
- *     const content = await readFile(join("path", "to", "my-file.txt"));
- *     console.log("File content:", content);
- *
- *     // Read a file as a Buffer
- *     const bufferContent = await readFile(join("path", "to", "another-file.bin"), { buffer: true });
- *     console.log("Buffer length:", bufferContent.length);
- *
- *     // Read and decompress a gzipped file
- *     // Assume my-archive.txt.gz exists
- *     // const decompressedContent = await readFile(join("path", "to", "my-archive.txt.gz"), { compression: "gzip", encoding: "utf8" });
- *     // console.log("Decompressed content:", decompressedContent);
- *   } catch (error) {
- *     console.error("Failed to read file:", error);
- *   }
- * };
- *
- * readMyFile();
- * ```
- */
-declare const readFile: <O extends ReadFileOptions<keyof typeof decompressionMethods> | undefined = undefined>(path: URL | string, options?: O) => Promise<ContentType<O>>;
-export default readFile;

package/dist/read/read-json-sync.d.ts

@@ -1,5 +0,0 @@
-import type { JsonValue } from "type-fest";
-import type { JsonReviver, ReadJsonOptions } from "../types.d.ts";
-declare function readJsonSync(path: URL | string, options?: ReadJsonOptions): JsonValue;
-declare function readJsonSync(path: URL | string, reviver: JsonReviver, options?: ReadJsonOptions): JsonValue;
-export default readJsonSync;

package/dist/read/read-json.d.ts

@@ -1,5 +0,0 @@
-import type { JsonValue } from "type-fest";
-import type { JsonReviver, ReadJsonOptions } from "../types.d.ts";
-declare function readJson<T extends JsonValue>(path: URL | string, options?: ReadJsonOptions): Promise<T>;
-declare function readJson<T extends JsonValue>(path: URL | string, reviver: JsonReviver, options?: ReadJsonOptions): Promise<T>;
-export default readJson;

package/dist/read/read-yaml-sync.d.ts

@@ -1,4 +0,0 @@
-import type { CompressionType, ReadYamlOptions, YamlReviver } from "../types.d.ts";
-declare function readYamlSync(path: URL | string, options?: ReadYamlOptions<CompressionType>): Record<string, unknown>;
-declare function readYamlSync(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<CompressionType>): Record<string, unknown>;
-export default readYamlSync;

package/dist/read/read-yaml.d.ts

@@ -1,4 +0,0 @@
-import type { CompressionType, ReadYamlOptions, YamlReviver } from "../types.d.ts";
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<CompressionType>): Promise<R>;
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<CompressionType>): Promise<R>;
-export default readYaml;

package/dist/remove/empty-dir-sync.d.ts

@@ -1,23 +0,0 @@
-import type { RetryOptions } from "../types.d.ts";
-/**
- * Ensures that a directory is empty.
- * Deletes directory contents if the directory is not empty.
- * If the directory does not exist, it is created.
- * The directory itself is not deleted.
- * @param dir The path to the directory to empty.
- * @param options Optional configuration for the operation. See {@link RetryOptions}.
- * @example
- * ```javascript
- * import { emptyDirSync } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * try {
- *   emptyDirSync(join("/tmp", "my-app-temp"));
- *   console.log("Temporary directory emptied or created.");
- * } catch (error) {
- *   console.error("Failed to empty directory:", error);
- * }
- * ```
- */
-declare const emptyDirSync: (dir: URL | string, options?: RetryOptions) => void;
-export default emptyDirSync;

package/dist/remove/empty-dir.d.ts

@@ -1,28 +0,0 @@
-import type { RetryOptions } from "../types.d.ts";
-/**
- * Ensures that a directory is empty.
- * Deletes directory contents if the directory is not empty.
- * If the directory does not exist, it is created.
- * The directory itself is not deleted.
- * @param dir The path to the directory to empty.
- * @param options Optional configuration for the operation. See {@link RetryOptions}.
- * @returns A promise that resolves when the directory is empty.
- * @example
- * ```javascript
- * import { emptyDir } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const clearTempDir = async () => {
- *   try {
- *     await emptyDir(join("/tmp", "my-app-temp"));
- *     console.log("Temporary directory emptied or created.");
- *   } catch (error) {
- *     console.error("Failed to empty directory:", error);
- *   }
- * };
- *
- * clearTempDir();
- * ```
- */
-declare const emptyDir: (dir: URL | string, options?: RetryOptions) => Promise<void>;
-export default emptyDir;

package/dist/remove/remove-sync.d.ts

@@ -1,27 +0,0 @@
-import type { RetryOptions } from "../types.d.ts";
-/**
- * Synchronously removes a file or directory (recursively).
- * If the path does not exist, it does nothing.
- * @param path The path to the file or directory to remove.
- * @param options Optional configuration for the operation. See {@link RetryOptions}.
- * @example
- * ```javascript
- * import { removeSync } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * try {
- *   removeSync(join("/tmp", "my-file.txt"));
- *   console.log("File /tmp/my-file.txt removed.");
- *
- *   removeSync(join("/tmp", "my-empty-dir"));
- *   console.log("Directory /tmp/my-empty-dir removed.");
- *
- *   removeSync(join("/tmp", "my-dir-with-contents"));
- *   console.log("Directory /tmp/my-dir-with-contents and its contents removed.");
- * } catch (error) {
- *   console.error("Failed to remove path:", error);
- * }
- * ```
- */
-declare const removeSync: (path: URL | string, options?: RetryOptions) => void;
-export default removeSync;

package/dist/remove/remove.d.ts

@@ -1,32 +0,0 @@
-import type { RetryOptions } from "../types.d.ts";
-/**
- * Asynchronously removes a file or directory (recursively).
- * If the path does not exist, it does nothing.
- * @param path The path to the file or directory to remove.
- * @param options Optional configuration for the operation. See {@link RetryOptions}.
- * @returns A promise that resolves when the path has been removed.
- * @example
- * ```javascript
- * import { remove } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const deleteFileOrDir = async () => {
- *   try {
- *     await remove(join("/tmp", "my-file.txt"));
- *     console.log("File /tmp/my-file.txt removed.");
- *
- *     await remove(join("/tmp", "my-empty-dir"));
- *     console.log("Directory /tmp/my-empty-dir removed.");
- *
- *     await remove(join("/tmp", "my-dir-with-contents"));
- *     console.log("Directory /tmp/my-dir-with-contents and its contents removed.");
- *   } catch (error) {
- *     console.error("Failed to remove path:", error);
- *   }
- * };
- *
- * deleteFileOrDir();
- * ```
- */
-declare const remove: (path: URL | string, options?: RetryOptions) => Promise<void>;
-export default remove;

package/dist/sanitize.d.ts

@@ -1,31 +0,0 @@
-/**
- * Supported filesystem types
- */
-export type FileSystemType = "win32" | "unix" | "darwin" | "fat32" | "auto";
-/**
- * Options for the sanitize function
- */
-export interface SanitizeOptions {
-    /**
-     * Target filesystem type for sanitization rules
-     * - "win32": Windows filesystem rules (reserved names, Windows forbidden chars, no trailing periods/spaces)
-     * - "unix": Unix/Linux filesystem rules (only / and null forbidden)
-     * - "darwin": macOS filesystem rules (same as unix)
-     * - "fat32": FAT32 filesystem rules (Windows rules + no leading/trailing spaces/periods in name part)
-     * - "auto": Automatically detect from process.platform
-     * @default "auto"
-     */
-    filesystem?: FileSystemType;
-    /**
-     * Maximum length of the sanitized name
-     * @default 128
-     */
-    maxLength?: number;
-}
-/**
- * Sanitizes a filename by removing or replacing forbidden characters.
- * @param name The filename to sanitize.
- * @param options Optional configuration.
- * @returns The sanitized filename, or "unnamed" if the result would be empty.
- */
-export declare const sanitize: (name: string, options?: Partial<SanitizeOptions>) => string;

package/dist/types.d.ts

@@ -1,304 +0,0 @@
-import type { Dirent, PathLike } from "node:fs";
-import type { CreateNodeOptions, DocumentOptions, ParseOptions, SchemaOptions, ToJSOptions, ToStringOptions } from "yaml";
-import type { FIND_UP_STOP } from "./constants.d.ts";
-type ColorizeMethod = (value: string) => string;
-/**
- * Options for the `walk` and `walkSync` functions.
- */
-export interface WalkOptions {
-    /**
-     * List of file extensions used to filter entries.
-     * If specified, entries without the file extension specified by this option are excluded.
-     * @default {undefined}
-     */
-    extensions?: string[];
-    /**
-     * Indicates whether symlinks should be resolved or not.
-     * @default {false}
-     */
-    followSymlinks?: boolean;
-    /**
-     * Indicates whether directory entries should be included or not.
-     * @default {true}
-     */
-    includeDirs?: boolean;
-    /**
-     * Indicates whether file entries should be included or not.
-     * @default {true}
-     */
-    includeFiles?: boolean;
-    /**
-     * Indicates whether symlink entries should be included or not.
-     * This option is meaningful only if `followSymlinks` is set to `false`.
-     * @default {true}
-     */
-    includeSymlinks?: boolean;
-    /**
-     * List of regular expression or glob patterns used to filter entries.
-     * If specified, entries that do not match the patterns specified by this option are excluded.
-     * @default {undefined}
-     */
-    match?: (RegExp | string)[];
-    /**
-     * The maximum depth of the file tree to be walked recursively.
-     * @default {Infinity}
-     */
-    maxDepth?: number;
-    /**
-     * List of regular expression or glob patterns used to filter entries.
-     * If specified, entries matching the patterns specified by this option are excluded.
-     * @default {undefined}
-     */
-    skip?: (RegExp | string)[];
-}
-/**
- * Represents an entry found by `walk` or `walkSync`.
- */
-export interface WalkEntry extends Pick<Dirent, "isDirectory" | "isFile" | "isSymbolicLink" | "name"> {
-    /** The full path to the entry. */
-    path: string;
-}
-/**
- * Supported compression types for file operations.
- */
-export type CompressionType = "brotli" | "gzip" | "none";
-/**
- * Supported file encodings for reading files.
- */
-export type ReadFileEncoding = "ascii" | "base64" | "base64url" | "hex" | "latin1" | "ucs-2" | "ucs2" | "utf-8" | "utf-16le" | "utf8" | "utf16le";
-/**
- * Options for reading files.
- * @template C - The type of compression used.
- */
-export type ReadFileOptions<C> = {
-    /**
-     * Return content as a Buffer. Default: `false`
-     */
-    buffer?: boolean;
-    /**
-     * Compression method to decompress the file against. Default: `none`
-     */
-    compression?: C;
-    /**
-     * The encoding to use. Default: `utf8`
-     * @see https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
-     */
-    encoding?: ReadFileEncoding;
-    /**
-     * The flag used to open the file. Default: `r`
-     */
-    flag?: number | string;
-};
-/**
- * Represents the content type of a read file, which can be a Buffer or a string based on options.
- * @template O - The ReadFileOptions type.
- */
-export type ContentType<O = undefined> = O extends {
-    buffer: true;
-} ? Buffer : string;
-/**
- * Type for the `reviver` parameter of `JSON.parse()`.
- * A function that transforms the results. This function is called for each member of the object.
- * If a member contains nested objects, the nested objects are transformed before the parent object is.
- */
-export type JsonReviver = Parameters<(typeof JSON)["parse"]>["1"];
-/**
- * Specifies a location (line and column) in a file for code frame generation.
- */
-export type CodeFrameLocation = {
-    /** The column number. */
-    column?: number;
-    /** The line number. */
-    line: number;
-};
-/**
- * Options for customizing the appearance of code frames.
- */
-export type CodeFrameOptions = {
-    /** Colorization methods for different parts of the code frame. */
-    color?: {
-        /** Color for the gutter (line numbers). */
-        gutter?: ColorizeMethod;
-        /** Color for the marker (pointing to the error). */
-        marker?: ColorizeMethod;
-        /** Color for the message. */
-        message?: ColorizeMethod;
-    };
-};
-/**
- * Options for reading and parsing JSON files.
- * Extends {@link CodeFrameOptions}.
- */
-export type ReadJsonOptions = CodeFrameOptions & {
-    /**
-     * A function to transform the string content before parsing.
-     * @param source The raw string content of the file.
-     * @returns The transformed string content.
-     */
-    beforeParse?: (source: string) => string;
-};
-/**
- * Options for writing files.
- */
-export type WriteFileOptions = {
-    /**
-     * The group and user ID used to set the file ownership. Default: `undefined`
-     */
-    chown?: {
-        gid: number;
-        uid: number;
-    };
-    /**
-     * The encoding to use. Default: `utf8`
-     */
-    encoding?: BufferEncoding | null;
-    /**
-     * The flag used to write the file. Default: `w`
-     */
-    flag?: string;
-    /**
-     * The file mode (permission and sticky bits). Default: `0o666`
-     */
-    mode?: number;
-    /**
-     * Indicates whether the file should be overwritten if it already exists. Default: `false`
-     */
-    overwrite?: boolean;
-    /**
-     * Recursively create parent directories if needed. Default: `true`
-     */
-    recursive?: boolean;
-};
-/**
- * Type for the `replacer` parameter of `JSON.stringify()`.
- * Can be a function that alters the behavior of the stringification process,
- * or an array of strings and numbers that acts as a whitelist for selecting
- * the properties of the value object to be included in the JSON string.
- * If this value is null or not provided, all properties of the object are included in the resulting JSON string.
- */
-export type JsonReplacer = (number | string)[] | ((this: unknown, key: string, value: unknown) => unknown) | null;
-/**
- * Type for the `replacer` parameter used in YAML serialization, similar to `JSON.stringify`'s replacer.
- * @deprecated Use {@link JsonReplacer} directly instead.
- */
-export type YamlReplacer = JsonReplacer;
-/**
- * Options for writing JSON files.
- * Extends {@link WriteFileOptions}.
- */
-export type WriteJsonOptions = WriteFileOptions & {
-    /**
-     * Detect indentation automatically if the file exists. Default: `false`
-     */
-    detectIndent?: boolean;
-    /**
-     * The space used for pretty-printing.
-     *
-     * Pass in `undefined` for no formatting.
-     */
-    indent?: number | string;
-    /**
-     * Passed into `JSON.stringify`.
-     */
-    replacer?: JsonReplacer;
-    /**
-     * Override the default `JSON.stringify` method.
-     */
-    stringify?: (data: unknown, replacer: JsonReplacer, space: number | string | undefined) => string;
-};
-/**
- * Options for the `findUp` and `findUpSync` functions.
- */
-export type FindUpOptions = {
-    /**
-     * Whether to follow symbolic links.
-     * @default undefined (behaves like `true` for `findUp`, `false` for `findUpSync` due to `fs.stat` vs `fs.lstat`)
-     */
-    allowSymlinks?: boolean;
-    /**
-     * The current working directory.
-     * @default process.cwd()
-     */
-    cwd?: URL | string;
-    /**
-     * The directory to stop searching at.
-     * @default path.parse(cwd).root
-     */
-    stopAt?: URL | string;
-    /**
-     * The type of path to find.
-     * @default "file"
-     */
-    type?: "directory" | "file";
-};
-/**
- * The result type for the name matcher function used in `findUp`.
- * It can be a `PathLike` (string, Buffer, or URL), a Promise resolving to `PathLike` or `FIND_UP_STOP`,
- * `FIND_UP_STOP` to stop the search, or `undefined` to continue.
- */
-export type FindUpNameFnResult = PathLike | Promise<PathLike | typeof FIND_UP_STOP> | typeof FIND_UP_STOP | undefined;
-/**
- * Specifies the name(s) of the file or directory to search for in `findUp`.
- * Can be a single name, an array of names, or a function that returns a name or `FIND_UP_STOP`.
- */
-export type FindUpName = string[] | string | ((directory: string) => FindUpNameFnResult);
-/**
- * The result type for the name matcher function used in `findUpSync`.
- * It can be a `PathLike` (string, Buffer, or URL), `FIND_UP_STOP` to stop the search,
- * or `undefined` to continue.
- */
-export type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
-/**
- * Specifies the name(s) of the file or directory to search for in `findUpSync`.
- * Can be a single name, an array of names, or a function that returns a name or `FIND_UP_STOP`.
- */
-export type FindUpNameSync = string[] | string | ((directory: string) => FindUpNameSyncFnResult);
-/**
- * Options for operations that might require retries, like `emptyDir` or `remove`.
- */
-export type RetryOptions = {
-    /**
-     * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
-     * `EPERM` error is encountered, Node.js will retry the operation with a linear
-     * backoff wait of `retryDelay` ms longer on each try. This option represents the
-     * number of retries. This option is ignored if the `recursive` option is not
-     * `true` for operations that support it (like `rm`).
-     * @default 0
-     */
-    maxRetries?: number;
-    /**
-     * The amount of time in milliseconds to wait between retries.
-     * This option is ignored if the `recursive` option is not `true` for operations that support it.
-     * @default 100
-     */
-    retryDelay?: number;
-};
-/**
- * Options for reading YAML files.
- * Combines options from `yaml` library (DocumentOptions, ParseOptions, SchemaOptions, ToJSOptions)
- * and custom {@link ReadFileOptions}.
- * @template C - The type of compression used.
- */
-export type ReadYamlOptions<C> = DocumentOptions & ParseOptions & ReadFileOptions<C> & SchemaOptions & ToJSOptions;
-/**
- * Type for the `reviver` parameter used in YAML deserialization, similar to `JSON.parse`'s reviver.
- * A function that transforms the results. This function is called for each member of the object.
- * If a member contains nested objects, the nested objects are transformed before the parent object is.
- */
-export type YamlReviver = (key: unknown, value: unknown) => unknown;
-/**
- * Options for writing YAML files.
- * Extends {@link WriteFileOptions} and includes options from the `yaml` library for stringification.
- */
-export type WriteYamlOptions = CreateNodeOptions & DocumentOptions & ParseOptions & SchemaOptions & ToStringOptions & WriteFileOptions & {
-    /**
-     * Passed into `yaml.stringify` as the replacer argument.
-     */
-    replacer?: JsonReplacer;
-    /**
-     * Passed into `yaml.stringify` as the space argument for indentation.
-     * Can be a number of spaces or a string (e.g., a tab character).
-     */
-    space?: number | string;
-};
-export {};