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

package/dist/utils/assert-valid-file-contents.d.ts

@@ -1,27 +0,0 @@
-/**
- * Asserts that the provided contents are valid for writing to a file.
- * Valid contents can be a string, an ArrayBuffer, or an ArrayBuffer view (e.g., Uint8Array).
- * @param contents The file contents to validate.
- * @throws {TypeError} If the contents are not a string, ArrayBuffer, or ArrayBuffer view.
- * @example
- * ```javascript
- * import { assertValidFileContents } from "@visulima/fs"; // Assuming this util is exported
- *
- * try {
- *   assertValidFileContents("Hello, world!");
- *   assertValidFileContents(new Uint8Array([72, 101, 108, 108, 111])); // "Hello"
- *   assertValidFileContents(new ArrayBuffer(8));
- *   console.log("File contents are valid.");
- * } catch (error) {
- *   console.error(error.message); // File contents must be a string, ArrayBuffer, or ArrayBuffer view.
- * }
- *
- * try {
- *   assertValidFileContents(123); // Invalid content type
- * } catch (error) {
- *   console.error(error.message); // File contents must be a string, ArrayBuffer, or ArrayBuffer view.
- * }
- * ```
- */
-declare const assertValidFileContents: (contents: any) => void;
-export default assertValidFileContents;

package/dist/utils/assert-valid-file-or-directory-path.d.ts

@@ -1,26 +0,0 @@
-/**
- * Asserts that the provided path is a valid file or directory path.
- * A valid path must be a non-empty string or a URL instance.
- * @param fileOrDirectoryPath The path to validate.
- * @throws {TypeError} If the path is not a non-empty string or a URL.
- * @example
- * ```javascript
- * import { assertValidFileOrDirectoryPath } from "@visulima/fs"; // Assuming this util is exported
- *
- * try {
- *   assertValidFileOrDirectoryPath("/path/to/file.txt");
- *   assertValidFileOrDirectoryPath(new URL("file:///path/to/file.txt"));
- *   console.log("Path is valid.");
- * } catch (error) {
- *   console.error(error.message); // Path must be a non-empty string or URL.
- * }
- *
- * try {
- *   assertValidFileOrDirectoryPath(""); // Invalid path
- * } catch (error) {
- *   console.error(error.message); // Path must be a non-empty string or URL.
- * }
- * ```
- */
-declare const assertValidFileOrDirectoryPath: (fileOrDirectoryPath: any) => void;
-export default assertValidFileOrDirectoryPath;

package/dist/utils/parse-json.d.ts

@@ -1,5 +0,0 @@
-import type { JsonValue } from "type-fest";
-import type { CodeFrameOptions, JsonReviver } from "../types.d.ts";
-declare function parseJson(string: string, filename?: string, options?: CodeFrameOptions): JsonValue;
-declare function parseJson(string: string, reviver: JsonReviver, fileName?: string, options?: CodeFrameOptions): JsonValue;
-export default parseJson;

package/dist/utils/strip-json-comments.d.ts

@@ -1,44 +0,0 @@
-/**
- * Strips comments from a JSON string.
- * Handles both single-line (//) and multi-line (/* ... */) comments.
- * @param jsonString The JSON string possibly containing comments.
- * @param [options] Optional configuration for stripping comments.
- * @param [options.whitespace] If `true` (default), comments are replaced with whitespace to preserve line numbers and character positions. If `false`, comments are removed entirely.
- * @returns The JSON string with comments stripped.
- * @example
- * ```javascript
- * import { stripJsonComments } from "@visulima/fs"; // Assuming this util is exported
- *
- * const jsonWithComments = `{
- *   // This is a single-line comment
- *   "name": "John Doe",
- *   "age": 30, /* This is a
- *   multi-line comment */
- *   "city": "New York"
- * }`;
- *
- * const stripped = stripJsonComments(jsonWithComments);
- * console.log(stripped);
- * // Output (with whitespace=true):
- * // {
- * //
- * //   "name": "John Doe",
- * //   "age": 30, /*
- * //
- * //   "city": "New York"
- * // }
- *
- * const strippedWithoutWhitespace = stripJsonComments(jsonWithComments, { whitespace: false });
- * console.log(strippedWithoutWhitespace);
- * // Output (with whitespace=false):
- * // {
- * //   "name": "John Doe",
- * //   "age": 30,
- * //   "city": "New York"
- * // }
- * ```
- */
-declare const stripJsonComments: (jsonString: string, options?: {
-    whitespace?: boolean;
-}) => string;
-export default stripJsonComments;

package/dist/write/utils/to-uint-8-array.d.ts

@@ -1,2 +0,0 @@
-declare const toUint8Array: (contents: any) => Uint8Array;
-export default toUint8Array;

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

@@ -1,30 +0,0 @@
-import type { WriteFileOptions } from "../types.d.ts";
-/**
- * Synchronously writes data to a file, replacing the file if it already exists.
- * This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
- * @param path The path to the file to write. Can be a file URL or a string path.
- * @param content The data to write. Can be a string, Buffer, ArrayBuffer, or ArrayBufferView.
- * @param options Optional configuration for writing the file. See {@link WriteFileOptions}.
- * @returns void
- * @example
- * ```javascript
- * import { writeFileSync } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const writeMyFileSync = () => {
- *   try {
- *     writeFileSync(join("/tmp", "my-new-file-sync.txt"), "Hello World Synchronously!");
- *     console.log("File written successfully (sync).");
- *
- *     writeFileSync(join("/tmp", "another-file-sync.txt"), "Some other sync content", { encoding: 'utf16le', mode: 0o600 });
- *     console.log("Another file written with specific options (sync).");
- *   } catch (error) {
- *     console.error("Failed to write file (sync):", error);
- *   }
- * };
- *
- * writeMyFileSync();
- * ```
- */
-declare const writeFileSync: (path: URL | string, content: ArrayBuffer | ArrayBufferView | string, options?: WriteFileOptions) => void;
-export default writeFileSync;

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

@@ -1,30 +0,0 @@
-import type { WriteFileOptions } from "../types.d.ts";
-/**
- * Asynchronously writes data to a file, replacing the file if it already exists.
- * This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
- * @param path The path to the file to write. Can be a file URL or a string path.
- * @param content The data to write. Can be a string, Buffer, ArrayBuffer, or ArrayBufferView.
- * @param options Optional configuration for writing the file. See {@link WriteFileOptions}.
- * @returns A promise that resolves when the file has been written.
- * @example
- * ```javascript
- * import { writeFile } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const writeMyFile = async () => {
- *   try {
- *     await writeFile(join("/tmp", "my-new-file.txt"), "Hello World!");
- *     console.log("File written successfully.");
- *
- *     await writeFile(join("/tmp", "another-file.txt"), "Some other content", { encoding: 'utf16le', mode: 0o600 });
- *     console.log("Another file written with specific options.");
- *   } catch (error) {
- *     console.error("Failed to write file:", error);
- *   }
- * };
- *
- * writeMyFile();
- * ```
- */
-declare const writeFile: (path: URL | string, content: ArrayBuffer | ArrayBufferView | string, options?: WriteFileOptions) => Promise<void>;
-export default writeFile;

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

@@ -1,29 +0,0 @@
-import type { WriteJsonOptions } from "../types.d.ts";
-/**
- * Synchronously writes an object to a JSON file.
- * Handles indentation detection, custom stringifiers, and gracefully manages existing files.
- * @param path The path to the JSON file to write. Can be a file URL or a string path.
- * @param data The data to serialize and write. Can be any JavaScript value that can be stringified by `JSON.stringify` or a custom stringifier.
- * @param options Optional configuration for writing the JSON file. See {@link WriteJsonOptions}.
- * @example
- * ```javascript
- * import { writeJsonSync } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const writeMyJsonSync = () => {
- *   try {
- *     writeJsonSync(join("/tmp", "my-config-sync.json"), { setting: "enabled", value: 456 });
- *     console.log("JSON file written successfully (sync).");
- *
- *     writeJsonSync(join("/tmp", "another-config-sync.json"), { user: "testSync", id: "def" }, { indent: 4, replacer: ["id"] });
- *     console.log("Another JSON file written with specific options (sync, indent 4, only 'id' key).");
- *   } catch (error) {
- *     console.error("Failed to write JSON file (sync):", error);
- *   }
- * };
- *
- * writeMyJsonSync();
- * ```
- */
-declare const writeJsonSync: (path: URL | string, data: unknown, options?: WriteJsonOptions) => void;
-export default writeJsonSync;

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

@@ -1,30 +0,0 @@
-import type { WriteJsonOptions } from "../types.d.ts";
-/**
- * Asynchronously writes an object to a JSON file.
- * Handles indentation detection, custom stringifiers, and gracefully manages existing files.
- * @param path The path to the JSON file to write. Can be a file URL or a string path.
- * @param data The data to serialize and write. Can be any JavaScript value that can be stringified by `JSON.stringify` or a custom stringifier.
- * @param options Optional configuration for writing the JSON file. See {@link WriteJsonOptions}.
- * @returns A promise that resolves when the JSON file has been written.
- * @example
- * ```javascript
- * import { writeJson } from "@visulima/fs";
- * import { join } from "node:path";
- *
- * const writeMyJson = async () => {
- *   try {
- *     await writeJson(join("/tmp", "my-config.json"), { setting: "enabled", value: 123 });
- *     console.log("JSON file written successfully.");
- *
- *     await writeJson(join("/tmp", "another-config.json"), { user: "test", id: "abc" }, { indent: 2, replacer: ["user"] });
- *     console.log("Another JSON file written with specific options (indent 2, only 'user' key).");
- *   } catch (error) {
- *     console.error("Failed to write JSON file:", error);
- *   }
- * };
- *
- * writeMyJson();
- * ```
- */
-declare const writeJson: (path: URL | string, data: unknown, options?: WriteJsonOptions) => Promise<void>;
-export default writeJson;

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

@@ -1,4 +0,0 @@
-import type { JsonReplacer, WriteYamlOptions } from "../types.d.ts";
-declare function writeYamlSync(path: URL | string, data: any, options?: WriteYamlOptions): void;
-declare function writeYamlSync(path: URL | string, data: any, replacer?: JsonReplacer, options?: WriteYamlOptions | number | string): void;
-export default writeYamlSync;

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

@@ -1,4 +0,0 @@
-import type { JsonReplacer, WriteYamlOptions } from "../types.d.ts";
-declare function writeYaml(path: URL | string, data: any, options?: WriteYamlOptions): Promise<void>;
-declare function writeYaml(path: URL | string, data: any, replacer?: JsonReplacer, options?: WriteYamlOptions | number | string): Promise<void>;
-export default writeYaml;