xypriss 9.10.19 → 9.10.21

package/dist/src/xhsc/fs/FSHelpers.d.ts

@@ -1,383 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { FSCore } from "./FSCore";
-/**
- * **Filesystem Convenience Helpers**
- */
-export declare class FSHelpers extends FSCore {
-    /**
-     * **Deep Recursive Directory Listing**
-     *
-     * Explores a directory tree and returns a flat array of all file and
-     * subdirectory paths found. Supports optional filtering.
-     *
-     * @param {string} p - Root path to start recursion.
-     * @param {Function} [filter] - Optional callback to include/exclude paths.
-     * @returns {string[]} Flat list of matching paths.
-     *
-     * @example
-     * const tsFiles = __sys__.fs.lsRecursive("./src", (path) => path.endsWith(".ts"));
-     */
-    lsRecursive: (p: string, filter?: (path: string) => boolean) => string[];
-    /**
-     * **Filter Directories Only**
-     *
-     * Returns a list of directory names within the specified path.
-     *
-     * @param {string} p - Path to scan.
-     * @returns {string[]} List of directory names.
-     */
-    lsDirs: (p: string) => string[];
-    /**
-     * **Filter Files Only**
-     *
-     * Returns a list of file names within the specified path.
-     *
-     * @param {string} p - Path to scan.
-     * @returns {string[]} List of file names.
-     */
-    lsFiles: (p: string) => string[];
-    /**
-     * **Read File (Asynchronous String)**
-     *
-     * Wrapper for `read()` that explicitly returns the content as a string.
-     *
-     * @param {string} p - Path to the file.
-     * @param {BufferEncoding} [encoding='utf8'] - Ignored (system uses native UTF-8).
-     * @returns {Promise<string>} File content string.
-     */
-    readFile: (p: string, encoding?: BufferEncoding) => Promise<string>;
-    /**
-     * **Read File (Synchronous String)**
-     *
-     * Wrapper for `readSync()` that explicitly returns the content as a string.
-     *
-     * @param {string} p - Path to the file.
-     * @param {BufferEncoding} [encoding='utf8'] - Ignored (system uses native UTF-8).
-     * @returns {string} File content string.
-     */
-    readFileSync: (p: string, encoding?: BufferEncoding) => string;
-    /**
-     * **Read & Parse JSON (Asynchronous)**
-     *
-     * Reads a file and parses its content into a JavaScript object.
-     *
-     * @template T - Expected object structure.
-     * @param {string} p - Path to the JSON file.
-     * @returns {Promise<T>} Parsed object.
-     */
-    readJson: <T = any>(p: string) => Promise<T>;
-    /**
-     * **Read & Parse JSON (Synchronous)**
-     *
-     * Synchronously reads a file and parses its content into a JavaScript object.
-     *
-     * @template T - Expected object structure.
-     * @param {string} p - Path to the JSON file.
-     * @returns {T} Parsed object.
-     *
-     * @example
-     * const config = __sys__.fs.readJsonSync("package.json");
-     */
-    readJsonSync: <T = any>(p: string) => T;
-    /**
-     * **Read File as Binary (Asynchronous)**
-     *
-     * Reads a file and returns its raw binary content as a Node.js Buffer.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {Promise<Buffer>} Binary data.
-     */
-    readBytes: (p: string) => Promise<Buffer>;
-    /**
-     * **Read File as Binary (Synchronous)**
-     *
-     * Synchronously reads a file and returns its raw binary content as a Node.js Buffer.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {Buffer} Binary data.
-     */
-    readBytesSync: (p: string) => Buffer;
-    /**
-     * **Write Binary Data (Asynchronous)**
-     *
-     * Writes a Node.js Buffer directly to a file.
-     *
-     * @param {string} p - Destination path.
-     * @param {Buffer} data - Binary data to write.
-     * @returns {Promise<void>}
-     */
-    writeBytes: (p: string, data: Buffer) => Promise<void>;
-    /**
-     * **Write Binary Data (Synchronous)**
-     *
-     * Synchronously writes a Node.js Buffer directly to a file.
-     *
-     * @param {string} p - Destination path.
-     * @param {Buffer} data - Binary data to write.
-     */
-    writeBytesSync: (p: string, data: Buffer) => void;
-    /**
-     * **Fault-Tolerant JSON Read (Asynchronous)**
-     *
-     * Attempts to read and parse a JSON file. If the file is missing or invalid,
-     * it returns a provided default value instead of throwing.
-     *
-     * @template T - Expected object structure.
-     * @param {string} p - Path to the JSON file.
-     * @param {T} defaultValue - Value to return on failure.
-     * @returns {Promise<T>} Parsed object or default value.
-     */
-    readJsonSafe: <T = any>(p: string, defaultValue: T) => Promise<T>;
-    /**
-     * **Fault-Tolerant JSON Read (Synchronous)**
-     *
-     * Synchronously attempts to read and parse a JSON file, returning a default
-     * value on any error.
-     *
-     * @template T - Expected object structure.
-     * @param {string} p - Path to the JSON file.
-     * @param {T} defaultValue - Value to return on failure.
-     * @returns {T} Parsed object or default value.
-     */
-    readJsonSafeSync: <T = any>(p: string, defaultValue: T) => T;
-    /**
-     * **Write Object as JSON (Asynchronous)**
-     *
-     * Serializes an object to JSON and writes it to a file.
-     *
-     * @param {string} p - Destination path.
-     * @param {any} data - Object to serialize.
-     * @returns {Promise<void>}
-     */
-    writeJson: (p: string, data: any) => Promise<void>;
-    /**
-     * **Write Object as JSON (Synchronous)**
-     *
-     * Synchronously serializes an object to JSON and writes it to a file.
-     *
-     * @param {string} p - Destination path.
-     * @param {any} data - Object to serialize.
-     */
-    writeJsonSync: (p: string, data: any) => void;
-    /**
-     * **Split File into Lines (Asynchronous)**
-     *
-     * Reads a file and splits its content into an array of lines based on
-     * platform-agnostic newline characters.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {Promise<string[]>} Array of lines.
-     */
-    readLines: (p: string) => Promise<string[]>;
-    /**
-     * **Split File into Lines (Synchronous)**
-     *
-     * Synchronously reads a file and splits its content into an array of lines.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {string[]} Array of lines.
-     */
-    readLinesSync: (p: string) => string[];
-    /**
-     * **Read Filtered Content (Asynchronous)**
-     *
-     * Reads a file and returns an array containing only non-empty, trimmed lines.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {Promise<string[]>} Array of non-empty lines.
-     */
-    readNonEmptyLines: (p: string) => Promise<string[]>;
-    /**
-     * **Read Filtered Content (Synchronous)**
-     *
-     * Synchronously reads a file and returns an array of non-empty, trimmed lines.
-     *
-     * @param {string} p - Path to the file.
-     * @returns {string[]} Array of non-empty lines.
-     */
-    readNonEmptyLinesSync: (p: string) => string[];
-    /**
-     * **Append Text to File (Asynchronous)**
-     *
-     * Adds content to the end of a file.
-     *
-     * @param {string} p - Path to the file.
-     * @param {any} data - Content to append.
-     * @returns {Promise<void>}
-     */
-    append: (p: string, data: any) => Promise<void>;
-    /**
-     * **Append Text to File (Synchronous)**
-     *
-     * Synchronously adds content to the end of a file.
-     *
-     * @param {string} p - Path to the file.
-     * @param {any} data - Content to append.
-     */
-    appendSync: (p: string, data: any) => void;
-    /**
-     * **Append Single Line (Asynchronous)**
-     *
-     * Adds content followed by a newline character to the end of a file.
-     *
-     * @param {string} p - Path to the file.
-     * @param {any} line - Line content to append.
-     * @returns {Promise<void>}
-     */
-    appendLine: (p: string, line: any) => Promise<void>;
-    /**
-     * **Append Single Line (Synchronous)**
-     *
-     * Synchronously adds a line of content to the end of a file.
-     *
-     * @param {string} p - Path to the file.
-     * @param {any} line - Line content to append.
-     */
-    appendLineSync: (p: string, line: any) => void;
-    /**
-     * **Write If New (Asynchronous)**
-     *
-     * Writes data to a file ONLY if the file does not already exist.
-     *
-     * @param {string} p - Destination path.
-     * @param {any} data - Data to write.
-     * @returns {Promise<boolean>} True if the file was written, false if it already existed.
-     */
-    writeIfNotExists: (p: string, data: any) => Promise<boolean>;
-    /**
-     * **Write If New (Synchronous)**
-     *
-     * Synchronously writes data to a file only if it does not already exist.
-     *
-     * @param {string} p - Destination path.
-     * @param {any} data - Data to write.
-     * @returns {boolean} True if written, false otherwise.
-     */
-    writeIfNotExistsSync: (p: string, data: any) => boolean;
-    /**
-     * **Ensure Directory Existence**
-     *
-     * Guarantees that a directory (and all its parents) exists. Does nothing
-     * if the directory is already present.
-     *
-     * @param {string} p - Directory path to ensure.
-     *
-     * @example
-     * __sys__.fs.ensureDir("./data/logs/archive");
-     */
-    ensureDir: (p: string) => void;
-    /**
-     * **Non-Blocking Directory Creation**
-     *
-     * Attempts to create a directory tree. Returns false if the path already exists.
-     *
-     * @param {string} p - Path to create.
-     * @returns {boolean} True if the directory was created.
-     */
-    mkdirSafe: (p: string) => boolean;
-    /**
-     * **List with Absolute Paths**
-     *
-     * Lists directory contents and returns them as a flat array of absolute paths.
-     *
-     * @param {string} p - Directory to scan.
-     * @returns {string[]} List of absolute paths.
-     */
-    lsFullPath: (p: string) => string[];
-    /**
-     * **Rename Entry**
-     *
-     * Alias for `move()`. Changes the name or location of a file/directory.
-     *
-     * @param {string} oldPath - Current path.
-     * @param {string} newPath - Target path.
-     */
-    rename: (oldPath: string, newPath: string) => void;
-    /**
-     * **Clone Entry**
-     *
-     * Creates a copy of a file or directory in the same parent folder with a new name.
-     *
-     * @param {string} p - Original path.
-     * @param {string} newName - New filename or directory name.
-     */
-    duplicate: (p: string, newName: string) => void;
-    /**
-     * **Safe Removal**
-     *
-     * Deletes a file or directory only if it currently exists on the filesystem.
-     *
-     * @param {string} p - Path to remove.
-     */
-    rmIfExists: (p: string) => void;
-    /**
-     * **Clear Directory Contents**
-     *
-     * Deletes all files and subdirectories within a directory, but keeps
-     * the empty directory itself.
-     *
-     * @param {string} p - Directory to empty.
-     */
-    emptyDir: (p: string) => void;
-    /**
-     * **Get Formatted Size String**
-     *
-     * Returns the size of a path in a human-readable format (e.g., '12 MB', '1.2 GB').
-     *
-     * @param {string} p - Path to query.
-     * @returns {string} Human-readable size.
-     */
-    sizeHuman: (p: string) => string;
-    /**
-     * **Get Creation Timestamp**
-     *
-     * Retrieves the exact date and time when the file or directory was created.
-     *
-     * @param {string} p - Path to query.
-     * @returns {Date} Creation date object.
-     */
-    createdAt: (p: string) => Date;
-    /**
-     * **Get Last Modification Timestamp**
-     *
-     * Retrieves the exact date and time when the file content or directory
-     * was last changed.
-     *
-     * @param {string} p - Path to query.
-     * @returns {Date} Modification date object.
-     */
-    modifiedAt: (p: string) => Date;
-    /**
-     * **Get Last Access Timestamp**
-     *
-     * Retrieves the exact date and time when the file was last accessed
-     * (read or written).
-     *
-     * @param {string} p - Path to query.
-     * @returns {Date} Access date object.
-     */
-    accessedAt: (p: string) => Date;
-    /**
-     * **Verify Content Identity**
-     *
-     * Compares two files to see if they have identical content by comparing
-     * their cryptographic hashes.
-     *
-     * @param {string} p1 - First file path.
-     * @param {string} p2 - Second file path.
-     * @returns {boolean} True if content is identical.
-     */
-    isSameContent: (p1: string, p2: string) => boolean;
-    /**
-     * **Compare Timestamps**
-     *
-     * Checks if the first path was modified more recently than the second path.
-     *
-     * @param {string} p1 - Primary path.
-     * @param {string} p2 - Path to compare against.
-     * @returns {boolean} True if p1 is newer than p2.
-     */
-    isNewer: (p1: string, p2: string) => boolean;
-}
-//# sourceMappingURL=FSHelpers.d.ts.map

package/dist/src/xhsc/fs/FSHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FSHelpers.d.ts","sourceRoot":"","sources":["../../../../src/xhsc/fs/FSHelpers.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACjC;;;;;;;;;;;;OAYG;IACI,WAAW,MACX,MAAM,WACA,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,KACnC,MAAM,EAAE,CAYT;IAEF;;;;;;;OAOG;IACI,MAAM,MAAO,MAAM,KAAG,MAAM,EAAE,CASnC;IAEF;;;;;;;OAOG;IACI,OAAO,MAAO,MAAM,KAAG,MAAM,EAAE,CASpC;IAEF;;;;;;;;OAQG;IACI,QAAQ,MACR,MAAM,aACC,cAAc,KACzB,QAAQ,MAAM,CAAC,CAAuB;IAEzC;;;;;;;;OAQG;IACI,YAAY,MACZ,MAAM,aACC,cAAc,KACzB,MAAM,CAAqB;IAE9B;;;;;;;;OAQG;IACI,QAAQ,eAAsB,MAAM,KAAG,QAAQ,CAAC,CAAC,CACrB;IAEnC;;;;;;;;;;;OAWG;IACI,YAAY,eAAgB,MAAM,KAAG,CAAC,CACZ;IAEjC;;;;;;;OAOG;IACI,SAAS,MAAa,MAAM,KAAG,QAAQ,MAAM,CAAC,CAMnD;IAEF;;;;;;;OAOG;IACI,aAAa,MAAO,MAAM,KAAG,MAAM,CAMxC;IAEF;;;;;;;;OAQG;IACI,UAAU,MAAa,MAAM,QAAQ,MAAM,KAAG,QAAQ,IAAI,CAAC,CAChC;IAElC;;;;;;;OAOG;IACI,cAAc,MAAO,MAAM,QAAQ,MAAM,KAAG,IAAI,CACvB;IAEhC;;;;;;;;;;OAUG;IACI,YAAY,eACZ,MAAM,gBACK,CAAC,KAChB,QAAQ,CAAC,CAAC,CAMX;IAEF;;;;;;;;;;OAUG;IACI,gBAAgB,eAAgB,MAAM,gBAAgB,CAAC,KAAG,CAAC,CAMhE;IAEF;;;;;;;;OAQG;IACI,SAAS,MAAa,MAAM,QAAQ,GAAG,KAAG,QAAQ,IAAI,CAAC,CAC5B;IAElC;;;;;;;OAOG;IACI,aAAa,MAAO,MAAM,QAAQ,GAAG,KAAG,IAAI,CACnB;IAEhC;;;;;;;;OAQG;IACI,SAAS,MAAa,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,CAErD;IAEF;;;;;;;OAOG;IACI,aAAa,MAAO,MAAM,KAAG,MAAM,EAAE,CAE1C;IAEF;;;;;;;OAOG;IACI,iBAAiB,MAAa,MAAM,KAAG,QAAQ,MAAM,EAAE,CAAC,CAE7D;IAEF;;;;;;;OAOG;IACI,qBAAqB,MAAO,MAAM,KAAG,MAAM,EAAE,CAElD;IAEF;;;;;;;;OAQG;IACI,MAAM,MAAa,MAAM,QAAQ,GAAG,KAAG,QAAQ,IAAI,CAAC,CAEzD;IAEF;;;;;;;OAOG;IACI,UAAU,MAAO,MAAM,QAAQ,GAAG,KAAG,IAAI,CAE9C;IAEF;;;;;;;;OAQG;IACI,UAAU,MAAa,MAAM,QAAQ,GAAG,KAAG,QAAQ,IAAI,CAAC,CAE7D;IAEF;;;;;;;OAOG;IACI,cAAc,MAAO,MAAM,QAAQ,GAAG,KAAG,IAAI,CAElD;IAEF;;;;;;;;OAQG;IACI,gBAAgB,MAChB,MAAM,QACH,GAAG,KACV,QAAQ,OAAO,CAAC,CAIjB;IAEF;;;;;;;;OAQG;IACI,oBAAoB,MAAO,MAAM,QAAQ,GAAG,KAAG,OAAO,CAI3D;IAEF;;;;;;;;;;OAUG;IACI,SAAS,MAAO,MAAM,KAAG,IAAI,CAElC;IAEF;;;;;;;OAOG;IACI,SAAS,MAAO,MAAM,KAAG,OAAO,CAIrC;IAEF;;;;;;;OAOG;IACI,UAAU,MAAO,MAAM,KAAG,MAAM,EAAE,CAGvC;IAEF;;;;;;;OAOG;IACI,MAAM,YAAa,MAAM,WAAW,MAAM,KAAG,IAAI,CAEtD;IAEF;;;;;;;OAOG;IACI,SAAS,MAAO,MAAM,WAAW,MAAM,KAAG,IAAI,CAGnD;IAEF;;;;;;OAMG;IACI,UAAU,MAAO,MAAM,KAAG,IAAI,CAEnC;IAEF;;;;;;;OAOG;IACI,QAAQ,MAAO,MAAM,KAAG,IAAI,CAKjC;IAEF;;;;;;;OAOG;IACI,SAAS,MAAO,MAAM,KAAG,MAAM,CAEpC;IAEF;;;;;;;OAOG;IACI,SAAS,MAAO,MAAM,KAAG,IAAI,CAElC;IAEF;;;;;;;;OAQG;IACI,UAAU,MAAO,MAAM,KAAG,IAAI,CAEnC;IAEF;;;;;;;;OAQG;IACI,UAAU,MAAO,MAAM,KAAG,IAAI,CAEnC;IAEF;;;;;;;;;OASG;IACI,aAAa,OAAQ,MAAM,MAAM,MAAM,KAAG,OAAO,CAEtD;IAEF;;;;;;;;OAQG;IACI,OAAO,OAAQ,MAAM,MAAM,MAAM,KAAG,OAAO,CAEhD;CACL"}